Skip to content

Commit eb8efd2

Browse files
authored
Fix more typos (#89)
* fix typos * fix formatting * fix missing spaces before units
1 parent a26b010 commit eb8efd2

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66

77
The general guidelines are to have documentation split into meaningful sections,
88
none of which are too long. If a new functionality is added then create a new
9-
documentation page in `src`. Then map that markdown file to the a section in the
9+
documentation page in `src`. Then map that markdown file to a section in the
1010
documentation in `make.jl` in the `pages` map.
1111

12-
## Previewing Documenation
12+
## Previewing Documentation
1313

1414
From the `docs` directory:
1515

src/ClusterSequence.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ final jets.
117117
to get the physical PseudoJet.
118118
- `Qtot::Any`: The total energy of the event.
119119
"""
120-
struct ClusterSequence{T<:FourMomentum}
120+
struct ClusterSequence{T <: FourMomentum}
121121
algorithm::JetAlgorithm.Algorithm
122122
power::Float64
123123
R::Float64
@@ -502,7 +502,7 @@ based on a given iteration number in the reconstruction.
502502
503503
# Arguments
504504
- `cs::ClusterSequence`: The `ClusterSequence` object to update.
505-
- `ranks`: The ranks of the original clusters, that are inherited by peudojets
505+
- `ranks`: The ranks of the original clusters, that are inherited by pseudojets
506506
during the reconstruction process.
507507
- `iteration=0`: The iteration number to consider for updating the
508508
reconstruction state (0 represents the initial state).

src/GenericAlgo.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ default is simply `+(jet1,jet2)`, i.e. 4-momenta addition or the *E*-scheme.
3636
## Consistency of `p`, `algorithm` and `R` arguments
3737
If an algorithm is explicitly specified the `p` value should be consistent with
3838
it or `nothing`. If the algorithm is one where `p` can vary, then it has to be
39-
given, along with the algorithm.``
39+
given, along with the algorithm.
4040
4141
If the `p` parameter is passed and `algorithm=nothing`, then pp-type
4242
reconstruction is implied (i.e., AntiKt, CA, Kt or GenKt will be used,
@@ -66,7 +66,7 @@ function jet_reconstruct(particles; p::Union{Real, Nothing} = -1, R = 1.0,
6666
if (algorithm === nothing) || is_pp(algorithm)
6767
# We assume a pp reconstruction
6868
if strategy == RecoStrategy.Best
69-
# The breakpoint of ~80 is determined empirically on e+e- -> H and 0.5TeV pp -> 5GeV jets
69+
# The breakpoint of ~80 is determined empirically on e+e- -> H and 0.5 TeV pp -> 5 GeV jets
7070
alg = length(particles) > 80 ? tiled_jet_reconstruct : plain_jet_reconstruct
7171
elseif strategy == RecoStrategy.N2Plain
7272
alg = plain_jet_reconstruct

test/data/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Files
44

5-
- `events.hepmc3.gz` - 100 Pythia 13TeV events in HepMC3 format (compressed)
5+
- `events.hepmc3.gz` - 100 Pythia 13 TeV events in HepMC3 format (compressed)
66
- Unzip to `evemts.hepmc3` for actual use
77

88
- `jet_collections_fastjet_akt.json` - JSON output from running anti-kt jet reconstruction using FastJet 3.4.1, with R=0.4 and p_t_min=5.0

0 commit comments

Comments
 (0)