8000 Add inline documentation to examples · Issue #331 · ebkalderon/tower-lsp · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add inline documentation to examples #331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
TimJentzsch opened this issue Mar 22, 2022 · 2 comments
Open

Add inline documentation to examples #331

TimJentzsch opened this issue Mar 22, 2022 · 2 comments
8000
Labels
documentation Improvements or additions to documentation

Comments

@TimJentzsch
Copy link

I think it would be valuable to add some inline documentation to the example files to make it easier to get started with tower-lsp.

Especially a top level comment explaining what is being showcased in this example, as well as maybe client usage notes would be very useful.

I'd also be willing to help with this if you want to add it.
@ebkalderon
Copy link
Owner

Sure, that sounds like it would be a great addition! Provided that the documentation isn't too heavy to the point of distraction and focuses primarily on explaining "why" and "how" behind the API, of course. Pull requests are always welcome and appreciated in this regard!

However, now that I think about it, perhaps it might be even more valuable to improve the rustdoc output for the crate by fleshing out the prose and adding inline Rust examples there rather than annotating the crate examples. Any thoughts on this?

@TimJentzsch
Copy link
Author

I think you're right on both points, not adding too much documentation is a good idea and improving the API doc itself would be valuable!

@ebkalderon ebkalderon added the documentation Improvements or additions to documentation label Mar 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ebkalderon @TimJentzsch
0