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

Avoid extensive usage of nodoc #259

Open
BuonOmo opened this issue Jun 1, 2021 · 0 comments
Open

Avoid extensive usage of nodoc #259

BuonOmo opened this issue Jun 1, 2021 · 0 comments

Comments

@BuonOmo
Copy link
Member

BuonOmo commented Jun 1, 2021

While adding new features, I could not retrieve them using ri or irb> polygon.make_valid!<tab><tab>. This was due to the fact that :nodoc: prevents documentation from handling correctly all of *Impl, and thus, could not redirect to documented methods correctly.

IMHO, we should consider:

  1. Removing most :nodoc:, checking if there is a real usage somewhere first,
  2. See the size augmentation of doc related to the repo (using rdoc),
  3. If (2.) concludes in too much documentation, or if we end up generating doc for tests, add options to make sure documentation is parsed correctly both by:
  • yard (for rubydoc.info)
  • rdoc (for ri tools, irb> my_feature.some_method<tab><tab> is a good test)
  1. add related tests if feasible.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant