Skip to content

Rashid/docs #113

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

Merged
merged 4 commits into from
Jul 2, 2018
Merged

Rashid/docs #113

merged 4 commits into from
Jul 2, 2018

Conversation

rashidsp
Copy link
Contributor

@rashidsp rashidsp commented Jun 25, 2018

The generated docs gh-pages branch

@coveralls
Copy link

coveralls commented Jun 25, 2018

Coverage Status

Coverage remained the same at 100.0% when pulling aa906d5 on rashid/docs into b2a4883 on master.

Copy link
Contributor

@mikeproeng37 mikeproeng37 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for submitting this!

Instead of using the query you have in .yardopts, can we instead explicitly opt-in for things that should be publicly documented?

I saw this in RDoc's documentation --query '@api.text == "public"'

I think this approach makes sense because there are more things to exclude than things to include.

@rashidsp
Copy link
Contributor Author

rashidsp commented Jul 2, 2018

@mikeng13 In that case modules will have to be set to public, which will eventually include all Inner methods and attributes, then we would need to exclude them explicitly.

@mikeproeng37 mikeproeng37 merged commit 29a511b into master Jul 2, 2018
@oakbani oakbani deleted the rashid/docs branch July 3, 2018 04:41
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

Successfully merging this pull request may close these issues.

3 participants