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

Jump to bottom

Lots of noise when generating docs #163

Closed
taylorfinnell opened this issue Sep 16, 2018 · 3 comments
Closed

Lots of noise when generating docs #163

taylorfinnell opened this issue Sep 16, 2018 · 3 comments
Assignees
@imdrasil
Labels
enhancement

Comments

@taylorfinnell
Copy link

When you run crystal docs a bunch of Jennifer internal code makes it into the html. Here is a screenshot showing what I mean.

https://imgur.com/a/hUGYOkG

I think it's just a matter of adding :nodoc: on some of the internals
@imdrasil imdrasil self-assigned this Sep 16, 2018
@imdrasil
Copy link
Owner

Agree. Will take a look

@imdrasil imdrasil mentioned this issue Sep 18, 2018
Merged
@imdrasil
Copy link
Owner

imdrasil commented Sep 18, 2018 •
edited

Hi @taylorfinnell . Take a look at the linked PR - I believe it removes all unnecessary documentation entries from the documentation. Let me know if there is still smth you would like to hide.

@taylorfinnell
Copy link
Author

Looks good to me!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@imdrasil imdrasil

Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@taylorfinnell @imdrasil