-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Values, OsValues not reachable in docs #505
Comments
Thanks for pointing this out! Yeah, it's been in the back of my mind that I need to go through and not only ensure each of these types of things is reachable, but also inter-linked between all the different pieces. I'm almost done with the base of the 3.x work to allow non-stringly typed usage (i.e. using enums as arg and subcommand keys), but I'll see if I can do this on the 2.x branch too. Thanks for the kind words 😄 |
I'll use this as the tracking issue for:
|
ArgSettings is another. |
ArgSettings was intentionally hidden since it's used internally, but I haven't yet decided if I wanted to expose it publicly. |
it's used as a public argument type for a method on Arg I believe. Since it's not linked, it's hard to understand exactly how those methods are used. |
Ah you're right, my mistake! |
Some types weren't viewable in the docs, such as `Values`, `OsValues`, and `ArgSettings`. All these types should now be browsable in the docs page. Relates to #505
docs: makes all publicly available types viewable in docs Some types weren't viewable in the docs, such as `Values`, `OsValues`, and `ArgSettings`. All these types should now be browsable in the docs page. Relates to #505
docs: makes all publicly available types viewable in docs Some types weren't viewable in the docs, such as `Values`, `OsValues`, and `ArgSettings`. All these types should now be browsable in the docs page. Relates to #505
All doc pages should now be inter-linked between other doc pages and Rust documentation. Closes #505
#508 takes care of all this. Finally, all types are inter-linked and the docs feel much more usable. |
docs: inter-links all types and pages All doc pages should now be inter-linked between other doc pages and Rust documentation. Closes #505
docs: inter-links all types and pages All doc pages should now be inter-linked between other doc pages and Rust documentation. Closes #505
Iterators Values and OsValues are not reachable in the docs (they are black, non-links). This is because they are
pub
but not really reachable, so they are not linked.Suggestion: Either make them reachable, or expand the documentation for values_of, values_of_os to spell it out exactly what the return value is (Iterator of X).
I'm new to this library, but it seems very solid, congratulations 😄
The text was updated successfully, but these errors were encountered: