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
Rework reference-style documentation #232
Labels
Comments
TedDriggs
added a commit
that referenced
this issue
Mar 1, 2022
This reference lists all supported attributes alphabetically. It should in future link to examples and higher-level documentation. Part of #232
TedDriggs
added a commit
that referenced
this issue
Mar 3, 2022
This reference lists all supported attributes alphabetically. It should in future link to examples and higher-level documentation. Part of #232
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
We have two parallel problems:
These feed on each other: As primary maintainer, I don't know where best to document #228, and therefore no crate user will know where to read about how to control the creation of constructors or build functions.
We can separate documentation into some areas:
This issue is going to focus on item #3: Reference-style documentation.
Thanks to
darling
, our attributes are actually fairly understandable indarling_opts.rs
- it's easy to see the root options item, and then each of the fields from there, and to recurse down to see what each one does. Unfortunately, those aren't exposed by rustdoc because those structs aren't public.Question 1: How best to surface these? Big reference in
README.md
? Crate-level docs in the readme block?The text was updated successfully, but these errors were encountered: