doc: fix doc attribute scope #104
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
Applying the `doc` attribute without `!` just applies it to the next item, and does not actually include the `README.md`. This PR fixes that by using `#!` instead to apply it to the entire scope, thus actually including the contents in the README.
|
fixed errors - doctests were running the poseidon examples from the README (which we now ignore with |
Merged
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.
Applying the
docattribute without!just applies it to the next item, and does not actually include theREADME.md. For example:This PR fixes that by using
#!instead to apply it to the entire scope, thus actually including the contents in the README.With this PR:
To test, run
cargo docwithinronkathon.edit: the latex rendering within the html seems janky, but this could be fixed in a followup PR.