Skip to content

Update legibility of formula to proper Latex Format #4390

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

Merged
merged 3 commits into from
Dec 31, 2020

Conversation

CloudChaoszero
Copy link
Contributor

@CloudChaoszero CloudChaoszero commented Dec 28, 2020

Description

  • Update Normal Distribution's PDF formula in the Developer Guide section to proper latex format
  • Add wiki hyperlink to PDF definition

Note: Added mid-step just to clarify why the PDF is resulted, as such.

Closes #4384

Output

From

cd docs/source
make html
make serve

We get
Example

* Update function to latex
* Add hyperlink
@codecov
Copy link

codecov bot commented Dec 28, 2020

Codecov Report

Merging #4390 (1426c46) into master (3cfee77) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #4390   +/-   ##
=======================================
  Coverage   88.04%   88.04%           
=======================================
  Files          88       88           
  Lines       14482    14482           
=======================================
  Hits        12750    12750           
  Misses       1732     1732           

Copy link
Contributor

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

Thanks @CloudChaoszero

Instead of writing where\mu=0, would it work to use the vertical "evaluated at" line (https://tex.stackexchange.com/questions/40160/math-symbol-question-vertical-bar-for-evaluated-at)?

Finally, I think the * sign, and the brackets around 2*\pi could be removed

@CloudChaoszero
Copy link
Contributor Author

@MarcoGorelli Sounds great. Made the update, seen below

Example 2

@MarcoGorelli
Copy link
Contributor

Thanks, looks good, but I think you'll want the vertical "evaluated at" line after the third operand, not after the fourth one

Also, could you address

I think the * sign, and the brackets around 2*\pi could be removed

Finally, there's a linting error due to trailing whitespace, could you resolve that please? See the style guide for how to run the checks, and feel free to ask if it's unclear

@CloudChaoszero
Copy link
Contributor Author

CloudChaoszero commented Dec 29, 2020

@MarcoGorelli , Ah, thanks for the tip--found and deleted the whitespace.

Moreover, I resolved the following & 'evaluated at' piece.

I think the * sign, and the brackets around 2*\pi could be removed

@twiecki twiecki merged commit e2ce815 into pymc-devs:master Dec 31, 2020
@twiecki
Copy link
Member

twiecki commented Dec 31, 2020

Thanks @CloudChaoszero!

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.

Improve legibility of formula from developer guide
3 participants