Comments (5)
I am not talking about making it a library. I am recommending this because you should add docs so that IDEs can use it to give us hints about what each function does rather than developers manually going to the implementation and reading the comments. It can give us description of items by just hovering over it
from binserve.
Nice, but I didn't mean that you just copy and paste the comments into docs but rather write some new lines as part of the docs. You should go check out this link to get more idea on how to write good docs
https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html
from binserve.
Hey @arijit79, thank you for raising this issue. binserve
is not a library, it's a tool/utility/software. There is no API in binserve
as you can see there is no lib.rs
in src/
. Although your issue gave me an idea, I should probably add an API for dynamic routes, template variables, and such, I will think about it. But at the moment, there is no need for it. 👍
from binserve.
Ah, that makes sense! I will convert the already written comments to Rust documentation comments when I get some time. If you want to help, you are more than welcome to open a PR! ❤️🙌
from binserve.
Yeah, I get it! What I meant by "convert to Rust documentation comments" was just that, I have written a little, just have to elaborate based on those. 👍
from binserve.
Related Issues (20)
- Move the ASCII art to a separate file HOT 5
- Feature request: optional HTTPS support with automatically generated self-signed certificate HOT 4
- Append *.html files with .hbs extension HOT 1
- An optional Minify HTML feature HOT 1
- Store config in the cache HOT 1
- Add reverse-proxy functionality
- Support for handlebars partials HOT 3
- Add some CLI flags for typical config options HOT 2
- v0.2.0 Draft HOT 1
- Simpler run configurations without config file + tls instructions HOT 3
- Configuration file should be taken as an argument
- Write a dedicated documentation page (`DOCUMENTATION.md`)
- Implement rules for static files: custom index file & exclude specific files
- Relative routes on directories served from paths other than `/` is not correctly sorted
- `TcpListener` should implement `SO_REUSEPORT`
- Dockerfile
- Include Cargo.lock in the repository HOT 1
- Custom config location HOT 1
- Windows Version throws 404
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from binserve.