Add Markdown-style docstring refs #47
Merged
Conversation
This file contains hidden or 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
This PR adds Markdown-style references (e.g., [^ABC]: ...) to docstrings in new 'References' sections at the end for immediate readability in the REPL and in the source code without needing to open the Documenter-generated website. (Closes #44.)
Luis-Varona
force-pushed
the
44-md-references
branch
from
2ddd0a0 to
0241ca0
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Luis-Varona
added a commit
that referenced
this pull request
Aug 12, 2025
This PR adds Markdown-style references (e.g., [^ABC]: ...) to docstrings in new 'References' sections at the end for immediate readability in the REPL and in the source code without needing to open the Documenter-generated website. (Closes #44.)
Luis-Varona
added a commit
that referenced
this pull request
Aug 12, 2025
As a follow-up (patch?) to #47, we remove the Markdown-style [^ABC] references from the docstrings and keep the '@cite' formatting of Documenter. However, we maintain the separate 'References' sections at the bottom of each docstring that actually provide the full citation for immediate readability in the REPL and in the source code.
Luis-Varona
added a commit
that referenced
this pull request
Aug 12, 2025
As a follow-up (patch?) to #47, we remove the Markdown-style [^ABC] references from the docstrings and keep the '@cite' formatting of Documenter. However, we maintain the separate 'References' sections at the bottom of each docstring that actually provide the full citation for immediate readability in the REPL and in the source code.
Luis-Varona
added a commit
that referenced
this pull request
Aug 12, 2025
As a follow-up (patch?) to #47, we remove the Markdown-style [^ABC] references from the docstrings and keep the '@cite' formatting of Documenter. However, we maintain the separate 'References' sections at the bottom of each docstring that actually provide the full citations (in bullet points) for immediate readability in the REPL and in the source code.
Luis-Varona
added a commit
that referenced
this pull request
Aug 12, 2025
As a follow-up (patch?) to #47, we remove the Markdown-style [^ABC] references from the docstrings and keep the '@cite' formatting of Documenter. However, we maintain the separate 'References' sections at the bottom of each docstring that actually provide the full citations (in bullet points) for immediate readability in the REPL and in the source code.
Closed
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.
This PR adds Markdown-style references (e.g., [^ABC]: ...) to docstrings in new 'References' sections at the end for immediate readability in the REPL and in the source code without needing to open the Documenter-generated website.
(Closes #44.)