Skip to content

Commit

Permalink
changed directive ordering
Browse files Browse the repository at this point in the history
  • Loading branch information
jacanchaplais committed Feb 23, 2023
1 parent 33184cb commit 6dccb3b
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions graphicle/select.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ def fastjet_clusters(
"""Clusters particles using the FastJet implementation of the
generalised-kt algorithm.
:group: select
.. versionadded:: 0.2.3
Migrated from ``graphicle.calculate.cluster_pmu()``.
:group: select
Parameters
----------
pmu: gcl.MomentumArray
Expand Down Expand Up @@ -125,10 +125,10 @@ def find_vertex(
"""Locate vertices with the inward and outward particles of the
passed pdg codes.
.. versionadded:: 0.1.0
:group: select
.. versionadded:: 0.1.0
Parameters
----------
graph : Graphicle
Expand Down Expand Up @@ -201,12 +201,12 @@ def vertex_descendants(adj: gcl.AdjacencyList, vertex: int) -> gcl.MaskArray:
"""Return a mask over a graphicle object, identifying which
particles descend from a given interaction vertex.
:group: select
.. versionadded:: 0.1.0
.. versionchanged:: 0.1.11
Speed improvements by replacing NetworkX with SciPy.
:group: select
Performance enhancements.
Parameters
----------
Expand Down Expand Up @@ -235,10 +235,10 @@ def hadron_vertices(
) -> ty.Tuple[int, ...]:
"""Locates the hadronisation vertices in the generation DAG.
.. versionadded:: 0.1.11
:group: select
.. versionadded:: 0.1.11
Parameters
----------
adj : AdjacencyList
Expand Down Expand Up @@ -321,10 +321,10 @@ def partition_descendants(
"""Partitions the final state descendants with mixed hard partonic
heritage, by aligning them with their nearest ancestor.
.. versionadded:: 0.1.11
:group: select
.. versionadded:: 0.1.11
Parameters
----------
graph : Graphicle
Expand Down Expand Up @@ -441,14 +441,14 @@ def hard_descendants(
"""Returns a MaskGroup over the particles in the graph, where True
indicates a particle descends from a specific hard parton.
:group: select
.. versionadded:: 0.1.0
.. versionchanged:: 0.1.11
Target parameter now optional. Using default implies all hard
partons.
:group: select
Parameters
----------
graph : Graphicle
Expand Down Expand Up @@ -496,10 +496,10 @@ def hierarchy(
structure, such that partons which are descendants of other hard
partons are accessible, and nested within their parents.
.. versionadded:: 0.1.11
:group: select
.. versionadded:: 0.1.11
Parameters
----------
graph : Graphicle
Expand Down Expand Up @@ -671,10 +671,10 @@ def leaf_masks(mask_tree: gcl.MaskGroup) -> gcl.MaskGroup:
"""Find the leaves of the hard process, when organised into a
hierarchical tree from ``hierarchy()``.
.. versionadded:: 0.1.11
:group: select
.. versionadded:: 0.1.11
Parameters
----------
mask_tree : MaskGroup
Expand All @@ -696,10 +696,10 @@ def any_overlap(masks: gcl.MaskGroup) -> bool:
"""Given a MaskGroup object, checks if any of the masks overlap
with each other.
.. versionadded:: 0.1.0
:group: select
.. versionadded:: 0.1.0
Parameters
----------
masks : MaskGroup
Expand Down

0 comments on commit 6dccb3b

Please sign in to comment.