Skip to content

Commit 311ee63

Browse files
committed
cleanup of headings in examples and index
1 parent 8d0a70f commit 311ee63

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

docs/examples.rst

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ as a typed Python object.
66

77

88
Examples For Each Query Type
9-
------------------
9+
-----------------------------
1010
Examples for each query type (`Uproot-Raw`, `Func_ADL Uproot`, `Python Function`)
1111
and three different representations (`Python Dictionary`, `Python Typed Object`, and `YAML`).
1212
Note that all examples extract the same branch of the same tree (``ROOT TTree``) from
1313
the same :ref:`dataset <label_dataset>`.
1414

1515

1616
Uproot-Raw Query Example
17-
~~~~~~~~~~~~~~~~~~~~
17+
~~~~~~~~~~~~~~~~~~~~~~~~~
1818
This example uses the raw uproot query type to extract the ``AnalysisElectronsAuxDyn.pt`` branch
1919
from the ``CollectionTree`` tree in ATLAS PHYSLITE OpenData Dataset.
2020

@@ -37,7 +37,7 @@ from the ``CollectionTree`` tree in ATLAS PHYSLITE OpenData Dataset.
3737

3838

3939
Func_ADL Uproot Query Example
40-
~~~~~~~~~~~~~~~~~~~~
40+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4141
This example uses an Func_ADL to extract the ``AnalysisElectronsAuxDyn.pt`` branch
4242
from the ``CollectionTree`` tree in ATLAS PHYSLITE OpenData Dataset.
4343

@@ -60,7 +60,7 @@ from the ``CollectionTree`` tree in ATLAS PHYSLITE OpenData Dataset.
6060

6161

6262
Python Function Query Example
63-
~~~~~~~~~~~~~~~~~~~~
63+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6464
This example uses an uproot python function to extract the ``AnalysisElectronsAuxDyn.pt`` branch
6565
from the ``CollectionTree`` tree in ATLAS PHYSLITE OpenData Dataset.
6666
Note that you can specify a python function even in a yaml file.
@@ -84,14 +84,14 @@ Note that you can specify a python function even in a yaml file.
8484

8585

8686
The ServiceX Deliver Function
87-
-----------------------------
87+
------------------------------
8888
The `deliver` function is used to submit a request to ServiceX. It takes a request in one of the
8989
three formats and returns a python dictionary with the name of the sample as a key
9090
and a list of URLs or local file paths as a value.
9191

9292

9393
How to Use YAML Specification
94-
-----------------------------
94+
------------------------------
9595
YAML specification can be consumed by passing it to the ServiceX `deliver` function.
9696
You can use the following code:
9797

@@ -104,8 +104,9 @@ You can use the following code:
104104
)
105105
106106
.. _label_dataset:
107-
The Dataset in Examples
108-
-----------------------
109-
The dataset in the examples is publically accessible ATLAS Open Data
110-
(`ATLAS DAOD PHYSLITE format Run 2 2016 proton-proton collision data
111-
<https://opendata.cern.ch/record/80001>`_).
107+
108+
The Dataset in Examples
109+
-----------------------
110+
The dataset in the examples is publically accessible ATLAS Open Data
111+
(`ATLAS DAOD PHYSLITE format Run 2 2016 proton-proton collision data
112+
<https://opendata.cern.ch/record/80001>`_).

docs/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,6 @@ and then start looking in parent directories until a file is found.
182182
troubleshoot
183183
about
184184
modules
185-
examples/code_try
186185

187186
Indices and tables
188187
==================

0 commit comments

Comments
 (0)