Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up equations and units in docs #490

Closed
wants to merge 4 commits into from
Closed

Conversation

SouthEndMusic
Copy link
Contributor

I am a sucker for neat mathematical notation (: One of my first PRs to the Ribasim repository was also like this.

These are most of the types of changes I made:

  • Unified method for displaying units, without mixing $\TeX$ and non- $\TeX$
  • Variable names and subscripts that consist of multiple letters are non-italic to indicate that they form one 'word' (I am not a fan of variable names that consist of multiple letters but I understand that it is unavoidable sometimes)
  • Use proper symbols for partial derivatives

Some things still need to be fixed, I left some comments in a few places (most notably my question about what the unit t means).

I found DocumenterCitations.jl for a nicer incorporation of references, but given the plan to migrate the docs (#448) that might not be worth looking into.

@SouthEndMusic
Copy link
Contributor Author

Merged into #448.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant