Skip to content

Commit

Permalink
Fix a few typos in documentation (#671)
Browse files Browse the repository at this point in the history
  • Loading branch information
m-fila authored Sep 10, 2024
1 parent d04229c commit cf1f33c
Show file tree
Hide file tree
Showing 9 changed files with 13 additions and 13 deletions.
6 changes: 3 additions & 3 deletions doc/datamodel_syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,14 +212,14 @@ this schema version is a single integer. This makes it rather hard to use in
typical versioning, where one might differentiate between *major*, *minor* (and
*patch*) versions. Hence, the versioning of a datamodel and its schema version
are coupled but do not necessarily have to be the same. podio offers hooks to
store this important meta information into the produce files. In order to do you
can pass the version of the datamodel to the generator via the
store this important meta information into the produce files.
The version of the datamodel can be passed to the generator via the
`--datamodel-version` argument. It expects the version to conform to this
regular expression: `"v?\d+[\.|-]\d+([\.|-]\d+)?$"`, i.e. that the major and
minor version are present, separated by either a dot or comma with an optional
patch version and an optional `v` prefix.

If this this information is passed to the generator it will be injected into the
If this information is passed to the generator it will be injected into the
podio internals and will be stored in the output files. They can be retrieved
via the `currentFileVersion(const std::string&)` methods of the various readers.

Expand Down
6 changes: 3 additions & 3 deletions doc/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ By default a `.h` and a `.cc` file will be generated, but this can be overridden
With that in place it is now only necessary to call `_fill_templates` with the appropriate template name and the pre processed data.
Note that for most templates this means that they have to be filled for each datatype or component individually.

If additional preprocessing is necessary, it will be necessary to also add that to the the language specific generators.
If additional preprocessing is necessary, it will be necessary to also add that to the language specific generators.
The main entry point to the generation is the `process` method which essentially just delegates to other methods.

## Available information in the templates
Expand Down Expand Up @@ -99,10 +99,10 @@ The following keys / variables are filled for each datatype
|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class` | The (immutable, user-facing) class as `DataType` (see [below](#datatype)) |
| `Members` | The members of the datatype as a list of `MemberVariable`s (see [below](#membervariable)) |
| `OneToOneRelations` | The one-to-one relation members of the datatype as a list of `MemberVariable`s |
| `OneToOneRelations` | The one-to-one relation members of the datatype as a list of `MemberVariable`s |
| `OneToManyRelations` | The one-to-many relation members of the datatype as a list of `MemberVariable`s |
| `VectorMembers` | The vector members of the datatype as a list of `MemberVariable`s |
| `includes` | The include directives for the the user facing classes header files |
| `includes` | The include directives for the user facing classes header files |
| `includes_cc` | The include directives for the implementations of the user facing classes |
| `includes_data` | The necessary include directives for the `Data` POD types |
| `includes_obj` | The include directives for the `Obj` classes headers. |
Expand Down
2 changes: 1 addition & 1 deletion include/podio/Reader.h
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ class Reader {
public:
/// Create a reader from a low level reader
///
/// @tparam T The type of the low level reader (will bededuced)
/// @tparam T The type of the low level reader (will be deduced)
/// @param actualReader a low level reader that provides access to FrameDataT
template <typename T>
Reader(std::unique_ptr<T> actualReader);
Expand Down
2 changes: 1 addition & 1 deletion python/podio/test_Frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@


class FrameTest(unittest.TestCase):
"""General unittests for for python bindings of the Frame"""
"""General unittests for python bindings of the Frame"""

def test_frame_invalid_access(self):
"""Check that the advertised exceptions are raised on invalid access."""
Expand Down
2 changes: 1 addition & 1 deletion python/podio_gen/generator_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ class ClassGeneratorBaseMixin:
component dictionary further. When called only the
"class" key will be populated. Return a dictionary or
None. If None, this will not be put into the "components"
list. This function also has to to take care of filling
list. This function also has to take care of filling
the necessary templates!
do_process_datatype(name: str, datatype: dict): do some language specific
Expand Down
2 changes: 1 addition & 1 deletion src/ROOTLegacyReader.cc
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ void ROOTLegacyReader::openFiles(const std::vector<std::string>& filenames) {
delete versionPtr;

// Check if the CollectionTypeInfo branch is there and assume that the file
// has been written with with podio pre #197 (<0.13.1) if that is not the case
// has been written with podio pre #197 (<0.13.1) if that is not the case
if (auto* collInfoBranch = root_utils::getBranch(metadatatree, "CollectionTypeInfo")) {
auto collectionInfo = new std::vector<root_utils::CollectionWriteInfoT>;

Expand Down
2 changes: 1 addition & 1 deletion src/rootUtils.h
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ struct GPBranchOffsets {
constexpr auto nParamBranches = std::tuple_size_v<podio::SupportedGenericDataTypes> * 2;

/// Get the branch offsets for a given parameter type. In this case it is
/// assumed that the integer branches start immediately after the branche for
/// assumed that the integer branches start immediately after the branch for
/// the collections
template <typename T>
constexpr auto getGPBranchOffsets() {
Expand Down
2 changes: 1 addition & 1 deletion tests/read_frame.h
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ int read_frames(const std::string& filename, bool assertBuildVersion = true) {

const auto extensionModelVersion = reader.currentFileVersion("extension_model");
if (extensionModelVersion) {
std::cerr << "The (build) version of the extension model was available althought it shouldn't be. Its value is "
std::cerr << "The (build) version of the extension model was available although it shouldn't be. Its value is "
<< extensionModelVersion.value() << std::endl;
}

Expand Down
2 changes: 1 addition & 1 deletion tests/root_io/param_reading_rdataframe.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/usr/bin/env python3
"""Small test case for checking that utilities work as expeced in RDataFrame"""
"""Small test case for checking that utilities work as expected in RDataFrame"""

import sys
import ROOT
Expand Down

0 comments on commit cf1f33c

Please sign in to comment.