Skip to content

docs: fix dead internal references in script docstrings #61

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 #61

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
2 changes: 1 addition & 1 deletion notebooks/chapter_2_lens_modeling/tutorial_4_dealing_with_failure.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@
"In a previous tutorial, we learned how to fully customize priors. Let's apply this knowledge \n",
"now. I've set up a custom search below with priors adjusted to give the non-linear search a better chance of finding \n",
"the global maxima solution. I'll also explain how each prior has been changed from the default values specified in\n",
" the `config/priors/default` configuration files.\n",
" the `config/priors` configuration files.\n",
"\n",
"We will call our lens and source galaxies `lens` and `source` this time, for shorter more readable code.\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion notebooks/chapter_2_lens_modeling/tutorial_7_results.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@
"advanced queries, so specific results can be loaded and inspected.\n",
"\n",
"We won't go into any more detail on the database in this tutorial. If you think the database will be useful, checkout \n",
"the full set of database tutorials which can be found in the folder `autolens_workspace/*/imaging/advanced/database`. \n",
"the full set of database tutorials which can be found in the folder `autolens_workspace/*/guides/results/database`. \n",
"\n",
"Here, you'll learn how to:\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion notebooks/simulator/lens_sersic.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The dataset can be viewed in the folder `autolens_workspace/imaging/lens_sersic`."
"The dataset can be viewed in the folder `autolens_workspace/dataset/imaging/lens_sersic`."
]
}
],
Expand Down
2 changes: 1 addition & 1 deletion notebooks/simulator/lens_x2.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The dataset can be viewed in the folder `autolens_workspace/imaging/x2_lens_galaxies`."
"The dataset can be viewed in the folder `autolens_workspace/dataset/imaging/x2_lens_galaxies`."
]
}
],
Expand Down
2 changes: 1 addition & 1 deletion notebooks/simulator/no_lens_light.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The dataset can be viewed in the folder `autolens_workspace/imaging/simple__no_lens_light`."
"The dataset can be viewed in the folder `autolens_workspace/dataset/imaging/simple__no_lens_light`."
]
}
],
Expand Down
2 changes: 1 addition & 1 deletion notebooks/simulator/no_lens_light__mass_sis.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The dataset can be viewed in the folder `autolens_workspace/imaging/simple__no_lens_light`."
"The dataset can be viewed in the folder `autolens_workspace/dataset/imaging/simple__no_lens_light`."
]
}
],
Expand Down
4 changes: 2 additions & 2 deletions notebooks/simulator/source_complex.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"other examples, being composed of 4 Sersics.\n",
"\n",
"It is used to illustrate features which reconstruct the source galaxy's light using a pixelizaiton, for example\n",
"in the script `autolens_workspace/notebooks/modeling/features/pixelization`.\n",
"in the script `autolens_workspace/notebooks/imaging/features/pixelization`.\n",
"\n",
"__Contents__\n",
"\n",
Expand Down Expand Up @@ -378,7 +378,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The dataset can be viewed in the folder `autolens_workspace/imaging/source_complex`."
"The dataset can be viewed in the folder `autolens_workspace/dataset/imaging/source_complex`."
]
}
],
Expand Down
2 changes: 1 addition & 1 deletion scripts/chapter_2_lens_modeling/tutorial_4_dealing_with_failure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@
In a previous tutorial, we learned how to fully customize priors. Let's apply this knowledge
now. I've set up a custom search below with priors adjusted to give the non-linear search a better chance of finding
the global maxima solution. I'll also explain how each prior has been changed from the default values specified in
the `config/priors/default` configuration files.
the `config/priors` configuration files.

We will call our lens and source galaxies `lens` and `source` this time, for shorter more readable code.

Expand Down
2 changes: 1 addition & 1 deletion scripts/chapter_2_lens_modeling/tutorial_7_results.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@
advanced queries, so specific results can be loaded and inspected.

We won't go into any more detail on the database in this tutorial. If you think the database will be useful, checkout
the full set of database tutorials which can be found in the folder `autolens_workspace/*/imaging/advanced/database`.
the full set of database tutorials which can be found in the folder `autolens_workspace/*/guides/results/database`.

Here, you'll learn how to:

Expand Down
2 changes: 1 addition & 1 deletion scripts/simulator/lens_sersic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,5 +182,5 @@
)

"""
The dataset can be viewed in the folder `autolens_workspace/imaging/lens_sersic`.
The dataset can be viewed in the folder `autolens_workspace/dataset/imaging/lens_sersic`.
"""
2 changes: 1 addition & 1 deletion scripts/simulator/lens_x2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,5 +188,5 @@
)

"""
The dataset can be viewed in the folder `autolens_workspace/imaging/x2_lens_galaxies`.
The dataset can be viewed in the folder `autolens_workspace/dataset/imaging/x2_lens_galaxies`.
"""
2 changes: 1 addition & 1 deletion scripts/simulator/no_lens_light.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,5 +228,5 @@
)

"""
The dataset can be viewed in the folder `autolens_workspace/imaging/simple__no_lens_light`.
The dataset can be viewed in the folder `autolens_workspace/dataset/imaging/simple__no_lens_light`.
"""
2 changes: 1 addition & 1 deletion scripts/simulator/no_lens_light__mass_sis.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,5 +164,5 @@
)

"""
The dataset can be viewed in the folder `autolens_workspace/imaging/simple__no_lens_light`.
The dataset can be viewed in the folder `autolens_workspace/dataset/imaging/simple__no_lens_light`.
"""
4 changes: 2 additions & 2 deletions scripts/simulator/source_complex.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
other examples, being composed of 4 Sersics.

It is used to illustrate features which reconstruct the source galaxy's light using a pixelizaiton, for example
in the script `autolens_workspace/notebooks/modeling/features/pixelization`.
in the script `autolens_workspace/notebooks/imaging/features/pixelization`.

__Contents__

Expand Down Expand Up @@ -194,5 +194,5 @@
)

"""
The dataset can be viewed in the folder `autolens_workspace/imaging/source_complex`.
The dataset can be viewed in the folder `autolens_workspace/dataset/imaging/source_complex`.
"""
Loading