-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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
Notation guidance on documentation Style Guide #4820
Comments
Using meaningful names is a good rule of thumb, but sometimes it makes sense to use Greek as a shorthand, and makes equations easier to read. I vote for LaTeX over Unicode, as it is more flexible. |
I'm not sure about the last question. But I incorporated the other comments to the style guide here https://github.com/pymc-devs/pymc3/wiki/PyMC3-Jupyter-Notebook-Style-Guide |
Regardless of what is used in the equations, PyMC3 code should use the spelled letters We can also have meaningful names, but then the equations should use the same (both can be abbreviated to prevent cumbersome long names ofc). I am not against having some examples use meaningful names and others use Greek letters. I think this can depend on how abstract or applied the example is. |
Added the rule about no unicode variable names inside the code to the guidelines. Right now, variable naming guidelines look like this: Variable names
|
Updated to Variable names
so I'll close this issue |
Add guidance on notation to the Jupyter Notebook Style Guide, so that the style is consistent throughout the documentation.
@OriolAbril 's suggestion:
The text was updated successfully, but these errors were encountered: