Skip to content

fix LaTeX dot in diversification ratio formula #1788

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.

Sign up for GitHub

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+3 −3
Open

fix LaTeX dot in diversification ratio formula #1788

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
730fc65
fix LaTeX dot in diversification ratio formula
saishreyakumar Jun 19, 2025
8245df2
Merge branch 'main' into fix-latex-dot-diversification-ratio
williambdean Jun 22, 2025
aee0067
Merge branch 'main' into fix-latex-dot-diversification-ratio
williambdean Jul 24, 2025
19e4b50
Merge branch 'main' into fix-latex-dot-diversification-ratio
cetagostini Aug 10, 2025
588fd41
Merge branch 'main' into fix-latex-dot-diversification-ratio
williambdean Nov 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions pymc_marketing/mmm/utility.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,12 +534,12 @@ def diversification_ratio(
The Diversification Ratio is calculated as:

.. math::
DR = \frac{\\sum_{i=1}^{n} w_i \\cdot \\sigma_i}{\\sigma_p}
DR = \frac{\sum_{i=1}^{n} w_i \cdot \sigma_i}{\sigma_p} \
Copy link
Contributor

@TeemuSailynoja TeemuSailynoja Aug 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

According to the Sphinx documentation, the equation doesn't need a newline after the math call:

When the math is only one line of text, it can also be given as a directive argument:
.. math:: (a + b)^2 = a^2 + 2ab + b^2

Also, maybe the line should not terminate with \ which might be the cause of the rendering issue @williambdean is seeing..


where:
- :math:`w_i` is the weight of asset \\( i \\)
- :math:`\\sigma_i` is the volatility (standard deviation) of asset \\( i \\)
- :math:`\\sigma_p` is the volatility of the portfolio
- :math:`\sigma_i` is the volatility (standard deviation) of asset \\( i \\)
- :math:`\sigma_p` is the volatility of the portfolio

Parameters
----------
Expand Down