Minor Fix: Equation Formatting in Documentation #518
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
* Replace `\( \)` by `$ $` because the first one is not rendered in
Markdown
* Replace `\[ \]` by `$$ $$` due to the same reason
* Rename `\text{mean\_degree}` to `\mathrm{mean\_deg}` because the
original option would not render correctly on GitHub. After some
research this seems to be the best fix.
* Remove one trailing whitespace
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.
Problem:
The equations in two files in the documentation do not render as LaTeX. This issue appears to stem from how GitHub markdown processes LaTeX equations (see [1]).
Solution:
I replaced the
\( \)with$ $and the\[ \]with$$ $$as suggested in [1].I encountered a minor issue in the
docs/10_log-model_evaluation.mdfile:It appears that GitHub's markdown LaTeX does not accept
\_within a\text{}macro. No matter how I tried, it would not render correctly on GitHub. I researched potential solutions but found nothing more effective (see [2]). I decided to rename it to\mathrm{mean\_deg}, which renders in a way that is clear on GitHub.Additionally, my editor accidentally removed a small trailing whitespace.