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

Values, OsValues not reachable in docs #505

Closed
bluss opened this issue May 13, 2016 · 7 comments
Closed

Values, OsValues not reachable in docs #505

bluss opened this issue May 13, 2016 · 7 comments
Labels
A-docs Area: documentation, including docs.rs, readme, examples, etc... C-enhancement Category: Raise on the bar on expectations

Comments

@bluss
Copy link

bluss commented May 13, 2016

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 😄

@kbknapp
Copy link
Member

kbknapp commented May 13, 2016

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 😄

@kbknapp kbknapp added C-enhancement Category: Raise on the bar on expectations P2: need to have A-docs Area: documentation, including docs.rs, readme, examples, etc... labels May 13, 2016
@kbknapp
Copy link
Member

kbknapp commented May 13, 2016

I'll use this as the tracking issue for:

  • Ensure all public facing types are reachable
    • Values
    • OsValues
    • ArgSettings
  • Ensure all types are inter-linked

@bluss
Copy link
Author

bluss commented May 13, 2016

ArgSettings is another.

@kbknapp
Copy link
Member

kbknapp commented May 13, 2016

ArgSettings was intentionally hidden since it's used internally, but I haven't yet decided if I wanted to expose it publicly.

@bluss
Copy link
Author

bluss commented May 13, 2016

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.

@kbknapp
Copy link
Member

kbknapp commented May 13, 2016

Ah you're right, my mistake!

kbknapp added a commit that referenced this issue May 13, 2016
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
homu added a commit that referenced this issue May 14, 2016
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
homu added a commit that referenced this issue May 14, 2016
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
kbknapp added a commit that referenced this issue May 15, 2016
All doc pages should now be inter-linked between other doc pages and
Rust documentation.

Closes #505
@kbknapp
Copy link
Member

kbknapp commented May 15, 2016

#508 takes care of all this. Finally, all types are inter-linked and the docs feel much more usable.

homu added a commit that referenced this issue May 15, 2016
docs: inter-links all types and pages

All doc pages should now be inter-linked between other doc pages and
Rust documentation.

Closes #505
homu added a commit that referenced this issue May 15, 2016
docs: inter-links all types and pages

All doc pages should now be inter-linked between other doc pages and
Rust documentation.

Closes #505
@homu homu closed this as completed in #508 May 15, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation, including docs.rs, readme, examples, etc... C-enhancement Category: Raise on the bar on expectations
Projects
None yet
Development

No branches or pull requests

2 participants