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

Render math without # noqa: W605 comment #161

Merged
merged 2 commits into from
Mar 9, 2023
Merged

Render math without # noqa: W605 comment #161

merged 2 commits into from
Mar 9, 2023

Conversation

PicoCentauri
Copy link
Collaborator

@PicoCentauri PicoCentauri commented Mar 7, 2023

Math rendering in the docstrings is inline with a # noqa to prevent the linter to be unhappy. However, this makes the equations harder to understand. This PR converts the inline math equations to block math.

@PicoCentauri PicoCentauri added the documentation Improvements or additions to documentation label Mar 7, 2023
@PicoCentauri PicoCentauri force-pushed the math_rendering branch 3 times, most recently from bfaac8c to 8476b44 Compare March 7, 2023 11:54
@agoscinski agoscinski force-pushed the math_rendering branch 3 times, most recently from 65a936d to 309ca72 Compare March 7, 2023 13:09
Copy link
Collaborator

@agoscinski agoscinski left a comment

Choose a reason for hiding this comment

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

Thanks for the work, and for pushing us to fix the GitHub-readthedocs WebHooks

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

Successfully merging this pull request may close these issues.

2 participants