Skip to content

Commit

Permalink
fix ref to PR in docs (#957)
Browse files Browse the repository at this point in the history
* fix ref to PR in docs

* Update online_monitor.rst
  • Loading branch information
JoranAngevaare authored Mar 4, 2022
1 parent 538a379 commit e341819
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/source/build_release_notes.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ def convert_release_notes():
pr_number = pr_number[:-1]
if pr_number:
line = line.replace(f'#{pr_number}',
f'`#{pr_number} <https://github.com/AxFoundation/strax/pull/>`_'
f'`#{pr_number} <https://github.com/XENONnT/straxen/pull/{pr_number}>`_'
)
with_ref += line + '\n'
target = os.path.join(this_dir, 'reference', 'release_notes.rst')
Expand Down
6 changes: 4 additions & 2 deletions docs/source/online_monitor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ and start developing live-displays!
.. code-block:: python
import straxen
st = straxen.contexts.xenonnt_online(_add_online_monitor_frontend=True)
st = straxen.contexts.xenonnt_online(include_online_monitor=True)
# Allow unfinished runs to be loaded, even before the DAQ has finished processing this run!
st.set_context_config({'allow_incomplete': True})
Expand Down Expand Up @@ -65,6 +65,8 @@ At the time of writing, these were:
- ``online_peak_monitor``
- ``event_basics``
- ``veto_regions``
- ``online_monitor_nv``
- ``online_monitor_mv``

For the most up-to-date information, one can check the registration in the
``straxen.contexts.xenonnt_online`` context:
Expand All @@ -84,7 +86,7 @@ a few bigger files which makes it much faster to load next time.
.. code-block:: python
import straxen
st = straxen.contexts.xenonnt_online(_add_online_monitor_frontend=True)
st = straxen.contexts.xenonnt_online(include_online_monitor=True)
st.copy_to_frontend(latest_run_id, 'event_basics', rechunk=True)
One can look now where this run is stored:
Expand Down

0 comments on commit e341819

Please sign in to comment.