Documentation consistency fixes #175
Open
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
Signed-off-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
Signed-off-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
Collaborator
|
very many thanks @Zeitsperre 🍺 @davidhassell @kmuehlbauer @bnlawrence when you folks have a minute, could you pls drop by for a review? 🍻 |
davidhassell
requested changes
Jan 8, 2026
Collaborator
davidhassell
left a comment
davidhassell
left a comment
There was a problem hiding this comment.
Thanks. Very nice. I've made a few more tweaks ...
Co-authored-by: David Hassell <davidhassell@users.noreply.github.com>
Collaborator
|
@davidhassell shall we get this one in? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
This PR adjusts several small inconsistencies in the documentation and is an attempt to formalize the language a bit. The majority of changes are to ensure that libraries use double-backticks (
``LibraryName``), some phrases are a bit clearer to understand, and some notes and emphasized info are more visible in the documentation.Feel free to suggest additional changes or for me to undo some changes, as needed.
Checklist
Related: openjournals/joss-reviews#9688