Skip to content

docs: fix dead internal references in script docstrings #126

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

Merged
Jammy2211 merged 1 commit into from
Jul 30, 2026
Merged

docs: fix dead internal references in script docstrings #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions notebooks/cookbooks/samples.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,7 +458,7 @@
"\n",
"This fit used `Emcee` therefore we use `corner.py` for visualization via the `aplt.corner_cornerpy` function.\n",
"\n",
"The `autofit_workspace/*/plots` folder illustrates other packages that can be used to make these plots using\n",
"The `autofit_workspace/*/plot` folder illustrates other packages that can be used to make these plots using\n",
"the standard output results formats (e.g. `get_dist.py`)."
]
},
Expand Down Expand Up @@ -680,7 +680,7 @@
"\n",
"By combining this with the filtering tools below, specific parameters can be included or removed from the latex.\n",
"\n",
"Remember that the superscripts of a parameter are loaded from the config file `notation/label.yaml`, providing high\n",
"Remember that the superscripts of a parameter are loaded from the config file `notation.yaml`, providing high\n",
"levels of customization for how the parameter names appear in the latex table. This is especially useful if your model\n",
"uses the same model components with the same parameter, which therefore need to be distinguished via superscripts."
]
Expand Down
4 changes: 2 additions & 2 deletions scripts/cookbooks/samples.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@

This fit used `Emcee` therefore we use `corner.py` for visualization via the `aplt.corner_cornerpy` function.

The `autofit_workspace/*/plots` folder illustrates other packages that can be used to make these plots using
The `autofit_workspace/*/plot` folder illustrates other packages that can be used to make these plots using
the standard output results formats (e.g. `get_dist.py`).
"""
aplt.corner_cornerpy(samples=result.samples)
Expand Down Expand Up @@ -395,7 +395,7 @@

By combining this with the filtering tools below, specific parameters can be included or removed from the latex.

Remember that the superscripts of a parameter are loaded from the config file `notation/label.yaml`, providing high
Remember that the superscripts of a parameter are loaded from the config file `notation.yaml`, providing high
levels of customization for how the parameter names appear in the latex table. This is especially useful if your model
uses the same model components with the same parameter, which therefore need to be distinguished via superscripts.
"""
Expand Down
Loading