Skip to content
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.

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

Infer documentation and name from rustdoc #3

Open
slinkydeveloper opened this issue Apr 25, 2023 · 1 comment
Open

Infer documentation and name from rustdoc #3

slinkydeveloper opened this issue Apr 25, 2023 · 1 comment
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@slinkydeveloper
Copy link
Contributor

slinkydeveloper commented Apr 25, 2023

Hi, I was wondering if it's possible for a path to infer its documentation and summary from its rustdoc, in a similar fashion to how schemars does it: https://graham.cool/schemars/examples/6-doc_comments/

@Flowneee
Copy link
Owner

This even listed as TODO somewhere. It's actually should not be very hard to do, only problem I remember in schemars is that it handles complex markup incorrectly. For example first paragraph of documentation could be summary and the rest is documentation, unless it is not overridden by attribute.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants