Merge branch 'fix-doc-examples'

jlvdb · Nov 22, 2024 · e6dab28 · e6dab28
2 parents 06c4b23 + c078412
commit e6dab28
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/docs/source/user_guide/examples/1_initial.rst b/docs/source/user_guide/examples/1_initial.rst
@@ -16,3 +16,7 @@ catalog data:
     reference_path = "path/to/ref_data.{fits,pqt,hdf5}"
     ref_rand_path = "path/to/rand_data.{fits,pqt,hdf5}"
     unknown_path = "path/to/unk_data.{fits,pqt,hdf5}"
+
+.. Note::
+    To access the `yet_another_wizz` log messages (e.g. for debugging), check
+    the :ref:`logging<logging>` example.
diff --git a/docs/source/user_guide/examples/4_redshifts.rst b/docs/source/user_guide/examples/4_redshifts.rst
@@ -8,7 +8,7 @@ measured cross-correlation:
 
 .. code-block:: python
 
-    ncc = RedshiftData.from_corrfuncs(
+    ncc = yaw.RedshiftData.from_corrfuncs(
         cross_corr=cts_sp,
         ref_corr=cts_ss,
         # unk_corr=None,

diff --git a/docs/source/user_guide/examples/logging.rst b/docs/source/user_guide/examples/logging.rst
@@ -1,3 +1,5 @@
+.. _logging:
+
 Logging
 -------
-Original file line number
+Diff line change
@@ -1,3 +1,5 @@
+    .. _logging:
     Logging
     -------
@@ Expand Down @@