📚 DOCS: Note that autodoc expects rST docstrings #339
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
|
Thanks for submitting your first pull request! You are awesome! 🤗 |
Codecov Report
@@ Coverage Diff @@
## master #339 +/- ##
=======================================
Coverage 90.58% 90.58%
=======================================
Files 14 14
Lines 1826 1826
=======================================
Hits 1654 1654
Misses 172 172
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
Co-authored-by: Chris Sewell <[email protected]>
Co-authored-by: Chris Sewell <[email protected]>
chrisjsewell
changed the title
|
Congrats on your first merged pull request in this project! 🎉 |
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.
As suggested by @choldgraf in #228, add a warning block in the relevant section of the docs that makes it clear that docstrings are expected to be written in reStructuredText rather than Markdown when using the
autodocSphinx extension, and link to the aforementioned issue.