Generate toplevel docs correctly #7063
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixed crystal-lang#6637 Until now `crystal docs` needs to define public toplevel method for generating `toplevel.html`. It seems a bug. By this fix, `toplevel.html` is generated only if public toplevel constant, method or macro is defined under your project. I think it is proper behavior.
bcardiff
approved these changes
Nov 12, 2018
RX14
approved these changes
Nov 13, 2018
straight-shoota
added a commit
to straight-shoota/crystal
that referenced
this pull request
Nov 14, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixed #6637
Until now
crystal docsneeds to define public toplevel method for generatingtoplevel.html. It seems a bug.By this fix,
toplevel.htmlis generated only if public toplevel constant, method or macro is defined under your project. I think it is proper behavior.Thank you.