Skip to content

Commit 13b4ebb

Browse files
committed
fix power and algorithm args in docstring examples
1 parent 59488c3 commit 13b4ebb

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

src/PlainAlgo.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ space.
218218
219219
# Example
220220
```julia
221-
jets = plain_jet_reconstruct(particles; p = -1, R = 0.4)
221+
jets = plain_jet_reconstruct(particles; algorithm = JetAlgorithm.GenKt, p = -1, R = 0.4)
222222
jets = plain_jet_reconstruct(particles; algorithm = JetAlgorithm.Kt, R = 1.0)
223223
```
224224
"""

src/TiledAlgoLL.jl

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,8 @@ If both are given they must be consistent or an exception is thrown.
316316
317317
## Example
318318
```julia
319-
tiled_jet_reconstruct(particles::Vector{LorentzVectorHEP}; p = -1, R = 0.4)
319+
tiled_jet_reconstruct(particles::Vector{LorentzVectorHEP}; algorithm = JetAlgorithm.GenKt, p = 0.5, R = 0.4)
320+
tiled_jet_reconstruct(particles::Vector{LorentzVectorHEP}; algorithm = JetAlgorithm.AntiKt, R = 0.4)
320321
```
321322
"""
322323
function tiled_jet_reconstruct(particles::AbstractVector{T};
@@ -381,7 +382,7 @@ power parameter.
381382
382383
## Example
383384
```julia
384-
tiled_jet_reconstruct(particles::Vector{PseudoJet}; p = 1, R = 0.4)
385+
_tiled_jet_reconstruct(particles::Vector{PseudoJet}; algorithm = JetAlgorithm.Kt, p = 1, R = 0.4)
385386
```
386387
"""
387388
function _tiled_jet_reconstruct(particles::AbstractVector{PseudoJet};

0 commit comments

Comments
 (0)