Skip to content

Conversation

@Zeitsperre
Copy link

@Zeitsperre Zeitsperre commented Jan 7, 2026

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

  • This pull request has a descriptive title and labels
  • This pull request has a minimal description (most was discussed in the issue, but a two-liner description is still desirable)
  • Unit tests have been added (if codecov test fails)
  • Any changed dependencies have been added or removed correctly (if need be)
  • If you are working on the documentation, please ensure the current build passes
  • All tests pass

Related: openjournals/joss-reviews#9688

Signed-off-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
Signed-off-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
@valeriupredoi
Copy link
Collaborator

very many thanks @Zeitsperre 🍺 @davidhassell @kmuehlbauer @bnlawrence when you folks have a minute, could you pls drop by for a review? 🍻

Copy link
Collaborator

@davidhassell davidhassell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Very nice. I've made a few more tweaks ...

Co-authored-by: David Hassell <davidhassell@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants