From 3745ff034fb1d618f3dcd064cc8fc3e4759e789c Mon Sep 17 00:00:00 2001 From: tmadlener <16774861+tmadlener@users.noreply.github.com> Date: Thu, 18 Jan 2024 10:42:44 +0000 Subject: [PATCH] Update documentation for docs-on-gh-pages --- docs-on-gh-pages/ReleaseNotes.html | 1 + docs-on-gh-pages/advanced_topics.html | 5 +- docs-on-gh-pages/contributing.html | 1 + docs-on-gh-pages/cpp_api/api.html | 1 + .../class/classpodio_1_1_collection_base.html | 1 + ...sspodio_1_1_collection_buffer_factory.html | 5 +- .../classpodio_1_1_collection_i_d_table.html | 1 + ...io_1_1_datamodel_definition_collector.html | 1 + ...podio_1_1_datamodel_definition_holder.html | 1 + .../classpodio_1_1_datamodel_registry.html | 1 + .../cpp_api/class/classpodio_1_1_frame.html | 1 + .../classpodio_1_1_generic_parameters.html | 3 +- .../classpodio_1_1_i_collection_provider.html | 1 + .../class/classpodio_1_1_object_i_d.html | 1 + .../classpodio_1_1_r_o_o_t_frame_data.html | 1 + .../classpodio_1_1_r_o_o_t_frame_reader.html | 3 +- .../classpodio_1_1_r_o_o_t_frame_writer.html | 1 + .../classpodio_1_1_r_o_o_t_legacy_reader.html | 3 +- ...classpodio_1_1_r_o_o_t_n_tuple_reader.html | 1 + ...classpodio_1_1_r_o_o_t_n_tuple_writer.html | 1 + .../class/classpodio_1_1_relation_range.html | 1 + .../class/classpodio_1_1_s_i_o_block.html | 1 + .../classpodio_1_1_s_i_o_block_factory.html | 1 + ...spodio_1_1_s_i_o_block_library_loader.html | 1 + .../classpodio_1_1_s_i_o_block_user_data.html | 1 + ..._1_1_s_i_o_collection_i_d_table_block.html | 1 + ...podio_1_1_s_i_o_event_meta_data_block.html | 1 + ...lasspodio_1_1_s_i_o_file_t_o_c_record.html | 1 + .../classpodio_1_1_s_i_o_frame_data.html | 1 + .../classpodio_1_1_s_i_o_frame_reader.html | 3 +- .../classpodio_1_1_s_i_o_frame_writer.html | 1 + .../classpodio_1_1_s_i_o_legacy_reader.html | 3 +- ...io_1_1_s_i_o_numbered_meta_data_block.html | 1 + .../classpodio_1_1_schema_evolution.html | 7 +- .../classpodio_1_1_user_data_collection.html | 5 +- ...sspodio_1_1utils_1_1_maybe_shared_ptr.html | 3 +- docs-on-gh-pages/cpp_api/classlist.html | 1 + .../cpp_api/file/_collection_base_8h.html | 1 + .../cpp_api/file/_collection_branches_8h.html | 1 + .../file/_collection_buffer_factory_8h.html | 5 +- .../cpp_api/file/_collection_buffers_8h.html | 1 + .../file/_collection_i_d_table_8h.html | 1 + .../cpp_api/file/_datamodel_registry_8h.html | 1 + .../_datamodel_registry_i_o_helpers_8h.html | 1 + docs-on-gh-pages/cpp_api/file/_frame_8h.html | 1 + .../cpp_api/file/_frame_categories_8h.html | 5 +- .../cpp_api/file/_generic_parameters_8h.html | 5 +- .../file/_i_collection_provider_8h.html | 1 + .../cpp_api/file/_maybe_shared_ptr_8h.html | 3 +- .../cpp_api/file/_object_i_d_8h.html | 1 + .../cpp_api/file/_r_o_o_t_frame_data_8h.html | 1 + .../file/_r_o_o_t_frame_reader_8h.html | 7 +- .../file/_r_o_o_t_frame_writer_8h.html | 1 + .../file/_r_o_o_t_legacy_reader_8h.html | 3 +- .../file/_r_o_o_t_n_tuple_reader_8h.html | 1 + .../file/_r_o_o_t_n_tuple_writer_8h.html | 1 + .../cpp_api/file/_relation_range_8h.html | 1 + .../cpp_api/file/_s_i_o_block_8h.html | 1 + .../file/_s_i_o_block_user_data_8h.html | 1 + .../cpp_api/file/_s_i_o_frame_data_8h.html | 1 + .../cpp_api/file/_s_i_o_frame_reader_8h.html | 3 +- .../cpp_api/file/_s_i_o_frame_writer_8h.html | 1 + .../cpp_api/file/_s_i_o_legacy_reader_8h.html | 3 +- .../cpp_api/file/_schema_evolution_8h.html | 7 +- .../cpp_api/file/_type_helpers_8h.html | 1 + .../file/_user_data_collection_8h.html | 5 +- .../cpp_api/file/podio_version_8h.html | 1 + docs-on-gh-pages/cpp_api/filelist.html | 1 + .../cpp_api/namespace/namespacepodio.html | 33 ++++----- .../namespacepodio_1_1_category.html | 3 +- .../namespacepodio_1_1root__utils.html | 1 + .../namespacepodio_1_1sio__helpers.html | 1 + .../namespace/namespacepodio_1_1utils.html | 3 +- .../namespace/namespacepodio_1_1version.html | 1 + .../cpp_api/namespace/namespacesio.html | 1 + docs-on-gh-pages/cpp_api/namespacelist.html | 1 + ...ructpodio_1_1_collection_read_buffers.html | 1 + ...uctpodio_1_1_collection_write_buffers.html | 1 + ...ructpodio_1_1_frame_1_1_frame_concept.html | 1 + ...structpodio_1_1_frame_1_1_frame_model.html | 1 + ..._o_o_t_frame_reader_1_1_category_info.html | 1 + ..._o_o_t_frame_writer_1_1_category_info.html | 1 + ..._t_n_tuple_reader_1_1_collection_info.html | 1 + ..._t_n_tuple_writer_1_1_collection_info.html | 1 + .../structpodio_1_1_relation_names.html | 1 + ...dio_1_1_s_i_o_file_t_o_c_record_block.html | 1 + .../structpodio_1_1_s_i_o_map_block.html | 1 + .../structpodio_1_1_s_i_o_version_block.html | 1 + ...io_1_1_schema_evolution_1_1_map_index.html | 1 + ..._1root__utils_1_1_collection_branches.html | 1 + ..._1_maybe_shared_ptr_1_1_control_block.html | 1 + .../structpodio_1_1version_1_1_version.html | 1 + docs-on-gh-pages/cpp_api/structlist.html | 1 + docs-on-gh-pages/datamodel_syntax.html | 3 +- docs-on-gh-pages/design.html | 1 + docs-on-gh-pages/doc.html | 1 + docs-on-gh-pages/doc_title.html | 1 + docs-on-gh-pages/examples.html | 5 +- docs-on-gh-pages/frame.html | 1 + docs-on-gh-pages/genindex.html | 19 ++++- docs-on-gh-pages/index.html | 1 + docs-on-gh-pages/objects.inv | Bin 42614 -> 42659 bytes docs-on-gh-pages/py-modindex.html | 1 + docs-on-gh-pages/py_api/modules.html | 9 +++ docs-on-gh-pages/py_api/podio.html | 65 ++++++++++++++++-- .../py_api/podio_class_generator.html | 1 + docs-on-gh-pages/py_api/podio_gen.html | 3 +- .../py_api/podio_schema_evolution.html | 1 + docs-on-gh-pages/search.html | 1 + docs-on-gh-pages/searchindex.js | 2 +- docs-on-gh-pages/templates.html | 9 +-- docs-on-gh-pages/userdata.html | 1 + 112 files changed, 253 insertions(+), 67 deletions(-) diff --git a/docs-on-gh-pages/ReleaseNotes.html b/docs-on-gh-pages/ReleaseNotes.html index 76ec4ef54..751c2484a 100644 --- a/docs-on-gh-pages/ReleaseNotes.html +++ b/docs-on-gh-pages/ReleaseNotes.html @@ -400,6 +400,7 @@
Each element of the collection will be converted to a JSON object, where the keys are the same as in the datamodel definiton. +
Each element of the collection will be converted to a JSON object, where the keys are the same as in the datamodel definition. Components contained in the objects will similarly be similarly converted.
JSON is not foreseen as a mode for persistency, i.e. there is no plan to add the conversion from JSON to the in memory representation of the datamodel.
@@ -698,7 +699,7 @@DatamodelRe
refer to an EDM as the shared library (and the corresponding public headers)
that have been compiled from code that has been generated from a datamodel
definition in the original YAML file. In general whenever we refer to a
-datamodel in this context we mean the enitity as a whole, i.e. its definition
+datamodel in this context we mean the entity as a whole, i.e. its definition
in a YAML file, the concrete implementation as an EDM, as well as other related
information that is related to it.
Currently the DatamodelRegistry
provides mainly access to the original
diff --git a/docs-on-gh-pages/contributing.html b/docs-on-gh-pages/contributing.html
index 8499a6e99..393706a82 100644
--- a/docs-on-gh-pages/contributing.html
+++ b/docs-on-gh-pages/contributing.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/api.html b/docs-on-gh-pages/cpp_api/api.html
index af082fae5..efca66f2f 100644
--- a/docs-on-gh-pages/cpp_api/api.html
+++ b/docs-on-gh-pages/cpp_api/api.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_collection_base.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_collection_base.html
index 1a470225c..abc2d97f7 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_collection_base.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_collection_base.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_collection_buffer_factory.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_collection_buffer_factory.html
index 3e1b219a7..887b16058 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_collection_buffer_factory.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_collection_buffer_factory.html
@@ -402,6 +402,7 @@
podio.base_writer module
@@ -541,7 +542,7 @@ Class podio::CollectionBufferFactory
class CollectionBufferFactory
The CollectionBufferFactory allows to create buffers of known datatypes, which can then be populated by e.g.
readers. In order to support schema evolution, the buffers have a version and this factory will also require a schema version to create buffers.
-It is implemented as a singleton, which is populated at the time a shared datamodel library is loaded. It is assumed that that happens early on in the startup of an appliation, such that only a single thread will access the factory instance for registering datatypes. Since the necessary creation functions are part of the core datamodel library, this should be very easy to achieve by simply linking to that library. Once the factory is populated it can be safely accessed from multiple threads concurrently to obtain buffers.
+It is implemented as a singleton, which is populated at the time a shared datamodel library is loaded. It is assumed that that happens early on in the startup of an application, such that only a single thread will access the factory instance for registering datatypes. Since the necessary creation functions are part of the core datamodel library, this should be very easy to achieve by simply linking to that library. Once the factory is populated it can be safely accessed from multiple threads concurrently to obtain buffers.
Public Functions
@@ -579,7 +580,7 @@ Class podio::CollectionBufferFactory
collType – The collection type name (e.g. from collection->getTypeName())
version – The schema version the created buffers should have
-susbsetColl – Should the buffers be for a subset collection or not
+subsetColl – Should the buffers be for a subset collection or not
- Returns:
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_collection_i_d_table.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_collection_i_d_table.html
index 629477ed2..2c9397bcf 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_collection_i_d_table.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_collection_i_d_table.html
@@ -402,6 +402,7 @@
- podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_datamodel_definition_collector.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_datamodel_definition_collector.html
index b6ec9a9be..0c7254bc6 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_datamodel_definition_collector.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_datamodel_definition_collector.html
@@ -402,6 +402,7 @@
- podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_datamodel_definition_holder.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_datamodel_definition_holder.html
index d1b027639..ab72adc9c 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_datamodel_definition_holder.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_datamodel_definition_holder.html
@@ -402,6 +402,7 @@
- podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_datamodel_registry.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_datamodel_registry.html
index 2b01d4ece..635a9c4e4 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_datamodel_registry.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_datamodel_registry.html
@@ -402,6 +402,7 @@
- podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_frame.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_frame.html
index af2234d80..c898091f3 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_frame.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_frame.html
@@ -402,6 +402,7 @@
- podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_generic_parameters.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_generic_parameters.html
index 6f6c0019b..05a5b0cce 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_generic_parameters.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_generic_parameters.html
@@ -402,6 +402,7 @@
- podio.base_writer module
@@ -611,7 +612,7 @@ Class podio::GenericParameters
-
inline void setValue(const std::string &key, std::vector<std::string> values)
-Overlaod for catching initializer list setting of string vector values.
+Overload for catching initializer list setting of string vector values.
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_i_collection_provider.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_i_collection_provider.html
index 4c8342b40..40503529e 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_i_collection_provider.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_i_collection_provider.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_object_i_d.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_object_i_d.html
index 8147f0052..4f64c5dfd 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_object_i_d.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_object_i_d.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_frame_data.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_frame_data.html
index 6e22cf65e..c044d0109 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_frame_data.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_frame_data.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_frame_reader.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_frame_reader.html
index f33d467a9..7349aa2a3 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_frame_reader.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_frame_reader.html
@@ -402,6 +402,7 @@
podio.base_writer module
@@ -621,7 +622,7 @@ Class podio::ROOTFrameReader
std::vector<std::string_view> getAvailableCategories() const
-Get the names of all the availalable Frame categories in the current file(s)
+Get the names of all the available Frame categories in the current file(s)
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_frame_writer.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_frame_writer.html
index 202822bad..cb199f59f 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_frame_writer.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_frame_writer.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_legacy_reader.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_legacy_reader.html
index a572c9df0..58fb87674 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_legacy_reader.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_legacy_reader.html
@@ -402,6 +402,7 @@
podio.base_writer module
@@ -604,7 +605,7 @@ Class podio::ROOTLegacyReader
std::vector<std::string_view> getAvailableCategories() const
-Get the names of all the availalable Frame categories in the current file(s)
+Get the names of all the available Frame categories in the current file(s)
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_n_tuple_reader.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_n_tuple_reader.html
index 18258d443..a1fcf70dc 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_n_tuple_reader.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_n_tuple_reader.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_n_tuple_writer.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_n_tuple_writer.html
index 5ef80cb4c..9280ed132 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_n_tuple_writer.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_r_o_o_t_n_tuple_writer.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_relation_range.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_relation_range.html
index 37eb23c12..f3b0240b3 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_relation_range.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_relation_range.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_block.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_block.html
index 2ab4a231b..8c8c443ae 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_block.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_block.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_block_factory.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_block_factory.html
index 875c832eb..bdfa7a18f 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_block_factory.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_block_factory.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_block_library_loader.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_block_library_loader.html
index 9ccaaf093..0a70a9871 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_block_library_loader.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_block_library_loader.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_block_user_data.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_block_user_data.html
index d681fea64..1c640c78b 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_block_user_data.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_block_user_data.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_collection_i_d_table_block.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_collection_i_d_table_block.html
index fda8519cd..3b2789887 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_collection_i_d_table_block.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_collection_i_d_table_block.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_event_meta_data_block.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_event_meta_data_block.html
index 27d0e10d6..f866e9911 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_event_meta_data_block.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_event_meta_data_block.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_file_t_o_c_record.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_file_t_o_c_record.html
index 8626acc1f..f770ca0aa 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_file_t_o_c_record.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_file_t_o_c_record.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_frame_data.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_frame_data.html
index ab0d1ba9e..82f856cbd 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_frame_data.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_frame_data.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_frame_reader.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_frame_reader.html
index 706704526..30354f27b 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_frame_reader.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_frame_reader.html
@@ -402,6 +402,7 @@
podio.base_writer module
@@ -595,7 +596,7 @@ Class podio::SIOFrameReader
std::vector<std::string_view> getAvailableCategories() const
-Get the names of all the availalable Frame categories in the current file(s)
+Get the names of all the available Frame categories in the current file(s)
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_frame_writer.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_frame_writer.html
index 26014dde1..51817b8b7 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_frame_writer.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_frame_writer.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_legacy_reader.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_legacy_reader.html
index faa6dfe14..018316105 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_legacy_reader.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_legacy_reader.html
@@ -402,6 +402,7 @@
podio.base_writer module
@@ -599,7 +600,7 @@ Class podio::SIOLegacyReader
std::vector<std::string_view> getAvailableCategories() const
-Get the names of all the availalable Frame categories in the current file(s)
+Get the names of all the available Frame categories in the current file(s)
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_numbered_meta_data_block.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_numbered_meta_data_block.html
index b0e197984..a6eab31fa 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_numbered_meta_data_block.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_s_i_o_numbered_meta_data_block.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_schema_evolution.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_schema_evolution.html
index fba49cbc1..8a91d2932 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1_schema_evolution.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1_schema_evolution.html
@@ -402,6 +402,7 @@
podio.base_writer module
@@ -612,12 +613,12 @@ Class podio::SchemaEvolution
void registerEvolutionFunc(const std::string &collType, SchemaVersionT fromVersion, SchemaVersionT currentVersion, const EvolutionFuncT &evolutionFunc, Priority priority = Priority::UserDefined)
-Register an evoution function for a given collection type and given versions from where to where the evolution applies.
+Register an evolution function for a given collection type and given versions from where to where the evolution applies.
Several assumptions are in place here:
The current version has to be the same for all invocations for a given datatype.
An evolution function has to be registered for all possible versions from 1 to N - 1, where N is the current version
-An evolution function can only be registerd once for a given datatype and fromVersion
+An evolution function can only be registered once for a given datatype and fromVersion
For auto generated code the passed in priority has to be AutoGenerated otherwise it might override user defined functions
Even if a datatype does not require schema evolution it has to register an evolution function (e.g. the noOpSchemaEvolution below) in order to be known to the internal map.
@@ -628,7 +629,7 @@ Class podio::SchemaEvolutionpodio.base_writer module
@@ -561,7 +562,7 @@ Class podio::UserDataCollection
inline UserDataCollection(std::vector<BasicType> &&vec)
-Constructor from an existing vector (wich will be moved from!)
+Constructor from an existing vector (which will be moved from!)
@@ -676,7 +677,7 @@ Class podio::UserDataCollection
-
inline virtual void setSubsetCollection(bool) override
-declare this collection to be a subset collectionv - no effect
+declare this collection to be a subset collection - no effect
diff --git a/docs-on-gh-pages/cpp_api/class/classpodio_1_1utils_1_1_maybe_shared_ptr.html b/docs-on-gh-pages/cpp_api/class/classpodio_1_1utils_1_1_maybe_shared_ptr.html
index 2085cb050..886d0af85 100644
--- a/docs-on-gh-pages/cpp_api/class/classpodio_1_1utils_1_1_maybe_shared_ptr.html
+++ b/docs-on-gh-pages/cpp_api/class/classpodio_1_1utils_1_1_maybe_shared_ptr.html
@@ -402,6 +402,7 @@
podio.base_writer module
@@ -539,7 +540,7 @@ Class podio::utils::MaybeSharedPtr
template<typename T>
class MaybeSharedPtr
-“Semi-smart” pointer class for pointers that at some point during their lifetime might hand over management to another entitity.
+“Semi-smart” pointer class for pointers that at some point during their lifetime might hand over management to another entity.
E.g. Objects that are added to a collection will hand over the management of their Obj* to collection. In such a case two things need to be considered:
Other Objects with the same Obj* instance should not delete the managed Obj*, even if the last Object goes out of scope
Even if the managed Obj* is gone (e.g. collection has gone out of scope or was cleared), the remaining Object instances should still be able to gracefully destruct, even if they are at this point merely an “empty husk” The MaybeSharedPtr achieves this by having an optional control block that controls the lifetime of itself and potentially the managed Obj*.
diff --git a/docs-on-gh-pages/cpp_api/classlist.html b/docs-on-gh-pages/cpp_api/classlist.html
index 15b733a84..80e2c632c 100644
--- a/docs-on-gh-pages/cpp_api/classlist.html
+++ b/docs-on-gh-pages/cpp_api/classlist.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_collection_base_8h.html b/docs-on-gh-pages/cpp_api/file/_collection_base_8h.html
index 6fe5a244d..ec2eae8a8 100644
--- a/docs-on-gh-pages/cpp_api/file/_collection_base_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_collection_base_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_collection_branches_8h.html b/docs-on-gh-pages/cpp_api/file/_collection_branches_8h.html
index ba7fc50d5..5685fa54b 100644
--- a/docs-on-gh-pages/cpp_api/file/_collection_branches_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_collection_branches_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_collection_buffer_factory_8h.html b/docs-on-gh-pages/cpp_api/file/_collection_buffer_factory_8h.html
index f8ae61bf8..878b1619a 100644
--- a/docs-on-gh-pages/cpp_api/file/_collection_buffer_factory_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_collection_buffer_factory_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
@@ -542,7 +543,7 @@ File CollectionBufferFactory.h
Public Functions
@@ -580,7 +581,7 @@ File CollectionBufferFactory.h
collType – The collection type name (e.g. from collection->getTypeName())
version – The schema version the created buffers should have
-susbsetColl – Should the buffers be for a subset collection or not
+subsetColl – Should the buffers be for a subset collection or not
Returns:
diff --git a/docs-on-gh-pages/cpp_api/file/_collection_buffers_8h.html b/docs-on-gh-pages/cpp_api/file/_collection_buffers_8h.html
index 54b9959e1..7383db394 100644
--- a/docs-on-gh-pages/cpp_api/file/_collection_buffers_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_collection_buffers_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_collection_i_d_table_8h.html b/docs-on-gh-pages/cpp_api/file/_collection_i_d_table_8h.html
index 16a0c052f..6487cf0ad 100644
--- a/docs-on-gh-pages/cpp_api/file/_collection_i_d_table_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_collection_i_d_table_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_datamodel_registry_8h.html b/docs-on-gh-pages/cpp_api/file/_datamodel_registry_8h.html
index b1c85dd05..107aaf02a 100644
--- a/docs-on-gh-pages/cpp_api/file/_datamodel_registry_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_datamodel_registry_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_datamodel_registry_i_o_helpers_8h.html b/docs-on-gh-pages/cpp_api/file/_datamodel_registry_i_o_helpers_8h.html
index dc23796ed..77d569a9f 100644
--- a/docs-on-gh-pages/cpp_api/file/_datamodel_registry_i_o_helpers_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_datamodel_registry_i_o_helpers_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_frame_8h.html b/docs-on-gh-pages/cpp_api/file/_frame_8h.html
index de9659dbe..995f13bd2 100644
--- a/docs-on-gh-pages/cpp_api/file/_frame_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_frame_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_frame_categories_8h.html b/docs-on-gh-pages/cpp_api/file/_frame_categories_8h.html
index 9cc0bad24..6b8db6303 100644
--- a/docs-on-gh-pages/cpp_api/file/_frame_categories_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_frame_categories_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
@@ -541,7 +542,7 @@ File FrameCategories.h
inline std::string collMetadataParamName(const std::string &collName, const std::string ¶mName)
Create a parameterName that encodes the collection name and the parameter Name into one string.
-This codifies a convention that was decided on to store collection level parameters. These are parameters / metadata that are valid for all collections of a given name in a file, e.g. CellID encoding strings. These parameters are usually stored in a dedicated metadata Frame inside a file, see the predefined category names in the Cateogry namespace.
+This codifies a convention that was decided on to store collection level parameters. These are parameters / metadata that are valid for all collections of a given name in a file, e.g. CellID encoding strings. These parameters are usually stored in a dedicated metadata Frame inside a file, see the predefined category names in the Category namespace.
- Parameters:
@@ -577,7 +578,7 @@ File FrameCategories.h
-
constexpr const auto Metadata = "metadata"
-The metadata cateogry that is used to store a single Frame that holds data that is valid for a whole file, e.g.
+The metadata category that is used to store a single Frame that holds data that is valid for a whole file, e.g.
collection level parameters
diff --git a/docs-on-gh-pages/cpp_api/file/_generic_parameters_8h.html b/docs-on-gh-pages/cpp_api/file/_generic_parameters_8h.html
index f2a24abc2..83c265107 100644
--- a/docs-on-gh-pages/cpp_api/file/_generic_parameters_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_generic_parameters_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
@@ -574,7 +575,7 @@ File GenericParameters.h
template<typename T>
static constexpr bool isSupportedGenericDataType = detail::isAnyOrVectorOf<T, SupportedGenericDataTypes>
-Static bool for determining if a type T is a supported GenericParamter type.
+Static bool for determining if a type T is a supported GenericParameters type.
@@ -655,7 +656,7 @@ File GenericParameters.h
inline void setValue(const std::string &key, std::vector<std::string> values)
-Overlaod for catching initializer list setting of string vector values.
+Overload for catching initializer list setting of string vector values.
diff --git a/docs-on-gh-pages/cpp_api/file/_i_collection_provider_8h.html b/docs-on-gh-pages/cpp_api/file/_i_collection_provider_8h.html
index efa6a3eff..8e7335fbf 100644
--- a/docs-on-gh-pages/cpp_api/file/_i_collection_provider_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_i_collection_provider_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_maybe_shared_ptr_8h.html b/docs-on-gh-pages/cpp_api/file/_maybe_shared_ptr_8h.html
index d45eef4fe..a14bba17a 100644
--- a/docs-on-gh-pages/cpp_api/file/_maybe_shared_ptr_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_maybe_shared_ptr_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
@@ -572,7 +573,7 @@ File MaybeSharedPtr.htemplate<typename T>
class MaybeSharedPtr
#include <podio/utilities/MaybeSharedPtr.h>
-“Semi-smart” pointer class for pointers that at some point during their lifetime might hand over management to another entitity.
+“Semi-smart” pointer class for pointers that at some point during their lifetime might hand over management to another entity.
E.g. Objects that are added to a collection will hand over the management of their Obj* to collection. In such a case two things need to be considered:
Other Objects with the same Obj* instance should not delete the managed Obj*, even if the last Object goes out of scope
Even if the managed Obj* is gone (e.g. collection has gone out of scope or was cleared), the remaining Object instances should still be able to gracefully destruct, even if they are at this point merely an “empty husk” The MaybeSharedPtr achieves this by having an optional control block that controls the lifetime of itself and potentially the managed Obj*.
diff --git a/docs-on-gh-pages/cpp_api/file/_object_i_d_8h.html b/docs-on-gh-pages/cpp_api/file/_object_i_d_8h.html
index a9e8bb1e8..7fdceb3d6 100644
--- a/docs-on-gh-pages/cpp_api/file/_object_i_d_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_object_i_d_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_r_o_o_t_frame_data_8h.html b/docs-on-gh-pages/cpp_api/file/_r_o_o_t_frame_data_8h.html
index 2e69d9338..b13873d01 100644
--- a/docs-on-gh-pages/cpp_api/file/_r_o_o_t_frame_data_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_r_o_o_t_frame_data_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_r_o_o_t_frame_reader_8h.html b/docs-on-gh-pages/cpp_api/file/_r_o_o_t_frame_reader_8h.html
index 57a689e78..104123398 100644
--- a/docs-on-gh-pages/cpp_api/file/_r_o_o_t_frame_reader_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_r_o_o_t_frame_reader_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
@@ -622,7 +623,7 @@ File ROOTFrameReader.h
std::vector<std::string_view> getAvailableCategories() const
-Get the names of all the availalable Frame categories in the current file(s)
+Get the names of all the available Frame categories in the current file(s)
@@ -643,7 +644,7 @@ File ROOTFrameReader.h
-
void initCategory(CategoryInfo &catInfo, const std::string &name)
-Initialze the passed CategoryInfo by setting up the necessary branches, collection infos and all necessary meta data to be able to read entries with this name.
+Initialize the passed CategoryInfo by setting up the necessary branches, collection infos and all necessary meta data to be able to read entries with this name.
@@ -662,7 +663,7 @@ File ROOTFrameReader.h
-
std::unique_ptr<podio::ROOTFrameData> readEntry(ROOTFrameReader::CategoryInfo &catInfo)
-Read the data entry specified in the passed CategoryInfo, and increase the counter aferwards.
+Read the data entry specified in the passed CategoryInfo, and increase the counter afterwards.
In case the requested entry is larger than the available number of entries, return a nullptr.
diff --git a/docs-on-gh-pages/cpp_api/file/_r_o_o_t_frame_writer_8h.html b/docs-on-gh-pages/cpp_api/file/_r_o_o_t_frame_writer_8h.html
index 72195c2cc..dbbfde628 100644
--- a/docs-on-gh-pages/cpp_api/file/_r_o_o_t_frame_writer_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_r_o_o_t_frame_writer_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_r_o_o_t_legacy_reader_8h.html b/docs-on-gh-pages/cpp_api/file/_r_o_o_t_legacy_reader_8h.html
index e1e5a74bc..0d900fa9a 100644
--- a/docs-on-gh-pages/cpp_api/file/_r_o_o_t_legacy_reader_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_r_o_o_t_legacy_reader_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
@@ -605,7 +606,7 @@ File ROOTLegacyReader.h
std::vector<std::string_view> getAvailableCategories() const
-Get the names of all the availalable Frame categories in the current file(s)
+Get the names of all the available Frame categories in the current file(s)
diff --git a/docs-on-gh-pages/cpp_api/file/_r_o_o_t_n_tuple_reader_8h.html b/docs-on-gh-pages/cpp_api/file/_r_o_o_t_n_tuple_reader_8h.html
index fb44c1c6e..b597c0fbd 100644
--- a/docs-on-gh-pages/cpp_api/file/_r_o_o_t_n_tuple_reader_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_r_o_o_t_n_tuple_reader_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_r_o_o_t_n_tuple_writer_8h.html b/docs-on-gh-pages/cpp_api/file/_r_o_o_t_n_tuple_writer_8h.html
index eae367062..ccda8e2a8 100644
--- a/docs-on-gh-pages/cpp_api/file/_r_o_o_t_n_tuple_writer_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_r_o_o_t_n_tuple_writer_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_relation_range_8h.html b/docs-on-gh-pages/cpp_api/file/_relation_range_8h.html
index 986bf2ad8..7d81a2a3e 100644
--- a/docs-on-gh-pages/cpp_api/file/_relation_range_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_relation_range_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_s_i_o_block_8h.html b/docs-on-gh-pages/cpp_api/file/_s_i_o_block_8h.html
index dafc4c9c7..46a6faa25 100644
--- a/docs-on-gh-pages/cpp_api/file/_s_i_o_block_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_s_i_o_block_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_s_i_o_block_user_data_8h.html b/docs-on-gh-pages/cpp_api/file/_s_i_o_block_user_data_8h.html
index 51995cbec..6bd13a549 100644
--- a/docs-on-gh-pages/cpp_api/file/_s_i_o_block_user_data_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_s_i_o_block_user_data_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_s_i_o_frame_data_8h.html b/docs-on-gh-pages/cpp_api/file/_s_i_o_frame_data_8h.html
index 5790e2445..fcb391616 100644
--- a/docs-on-gh-pages/cpp_api/file/_s_i_o_frame_data_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_s_i_o_frame_data_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_s_i_o_frame_reader_8h.html b/docs-on-gh-pages/cpp_api/file/_s_i_o_frame_reader_8h.html
index 59207f2b4..1b59d3487 100644
--- a/docs-on-gh-pages/cpp_api/file/_s_i_o_frame_reader_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_s_i_o_frame_reader_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
@@ -596,7 +597,7 @@ File SIOFrameReader.h
std::vector<std::string_view> getAvailableCategories() const
-Get the names of all the availalable Frame categories in the current file(s)
+Get the names of all the available Frame categories in the current file(s)
diff --git a/docs-on-gh-pages/cpp_api/file/_s_i_o_frame_writer_8h.html b/docs-on-gh-pages/cpp_api/file/_s_i_o_frame_writer_8h.html
index 8c479a8fd..ba3cd2fdc 100644
--- a/docs-on-gh-pages/cpp_api/file/_s_i_o_frame_writer_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_s_i_o_frame_writer_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_s_i_o_legacy_reader_8h.html b/docs-on-gh-pages/cpp_api/file/_s_i_o_legacy_reader_8h.html
index 670ebdde6..771f772b0 100644
--- a/docs-on-gh-pages/cpp_api/file/_s_i_o_legacy_reader_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_s_i_o_legacy_reader_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
@@ -600,7 +601,7 @@ File SIOLegacyReader.h
std::vector<std::string_view> getAvailableCategories() const
-Get the names of all the availalable Frame categories in the current file(s)
+Get the names of all the available Frame categories in the current file(s)
diff --git a/docs-on-gh-pages/cpp_api/file/_schema_evolution_8h.html b/docs-on-gh-pages/cpp_api/file/_schema_evolution_8h.html
index ec275a1f0..851b72afb 100644
--- a/docs-on-gh-pages/cpp_api/file/_schema_evolution_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_schema_evolution_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
@@ -641,12 +642,12 @@ File SchemaEvolution.h
void registerEvolutionFunc(const std::string &collType, SchemaVersionT fromVersion, SchemaVersionT currentVersion, const EvolutionFuncT &evolutionFunc, Priority priority = Priority::UserDefined)
-Register an evoution function for a given collection type and given versions from where to where the evolution applies.
+Register an evolution function for a given collection type and given versions from where to where the evolution applies.
Several assumptions are in place here:
The current version has to be the same for all invocations for a given datatype.
An evolution function has to be registered for all possible versions from 1 to N - 1, where N is the current version
-An evolution function can only be registerd once for a given datatype and fromVersion
+An evolution function can only be registered once for a given datatype and fromVersion
For auto generated code the passed in priority has to be AutoGenerated otherwise it might override user defined functions
Even if a datatype does not require schema evolution it has to register an evolution function (e.g. the noOpSchemaEvolution below) in order to be known to the internal map.
@@ -657,7 +658,7 @@ File SchemaEvolution.hcollType – The fully qualified collection data type
fromVersion – The version from which this evolution function should apply
currentVersion – The current schema version for the data type
-evolutionFunc – The evolution function that evolves passed in buffers from fromVersion to currrentVersion
+evolutionFunc – The evolution function that evolves passed in buffers from fromVersion to currentVersion
priority – The priority of this evolution function. Defaults to UserDefined which overrides auto generated functionality.
diff --git a/docs-on-gh-pages/cpp_api/file/_type_helpers_8h.html b/docs-on-gh-pages/cpp_api/file/_type_helpers_8h.html
index 76f75be35..b0646590d 100644
--- a/docs-on-gh-pages/cpp_api/file/_type_helpers_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_type_helpers_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/file/_user_data_collection_8h.html b/docs-on-gh-pages/cpp_api/file/_user_data_collection_8h.html
index 31b0c4e4f..7ace47321 100644
--- a/docs-on-gh-pages/cpp_api/file/_user_data_collection_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/_user_data_collection_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
@@ -606,7 +607,7 @@ File UserDataCollection.h
inline UserDataCollection(std::vector<BasicType> &&vec)
-Constructor from an existing vector (wich will be moved from!)
+Constructor from an existing vector (which will be moved from!)
@@ -721,7 +722,7 @@ File UserDataCollection.h
-
inline virtual void setSubsetCollection(bool) override
-declare this collection to be a subset collectionv - no effect
+declare this collection to be a subset collection - no effect
diff --git a/docs-on-gh-pages/cpp_api/file/podio_version_8h.html b/docs-on-gh-pages/cpp_api/file/podio_version_8h.html
index 3fce1af5e..d6fae349a 100644
--- a/docs-on-gh-pages/cpp_api/file/podio_version_8h.html
+++ b/docs-on-gh-pages/cpp_api/file/podio_version_8h.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/filelist.html b/docs-on-gh-pages/cpp_api/filelist.html
index fc18bffe0..be25c11fc 100644
--- a/docs-on-gh-pages/cpp_api/filelist.html
+++ b/docs-on-gh-pages/cpp_api/filelist.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/namespace/namespacepodio.html b/docs-on-gh-pages/cpp_api/namespace/namespacepodio.html
index 1de350e31..bc0b51eab 100644
--- a/docs-on-gh-pages/cpp_api/namespace/namespacepodio.html
+++ b/docs-on-gh-pages/cpp_api/namespace/namespacepodio.html
@@ -402,6 +402,7 @@
podio.base_writer module
@@ -653,7 +654,7 @@ Namespace podio
inline std::string collMetadataParamName(const std::string &collName, const std::string ¶mName)
Create a parameterName that encodes the collection name and the parameter Name into one string.
-This codifies a convention that was decided on to store collection level parameters. These are parameters / metadata that are valid for all collections of a given name in a file, e.g. CellID encoding strings. These parameters are usually stored in a dedicated metadata Frame inside a file, see the predefined category names in the Cateogry namespace.
+This codifies a convention that was decided on to store collection level parameters. These are parameters / metadata that are valid for all collections of a given name in a file, e.g. CellID encoding strings. These parameters are usually stored in a dedicated metadata Frame inside a file, see the predefined category names in the Category namespace.
- Parameters:
@@ -713,7 +714,7 @@ Namespace podio
-
template<typename T>
static constexpr bool isSupportedGenericDataType = detail::isAnyOrVectorOf<T, SupportedGenericDataTypes>
-Static bool for determining if a type T is a supported GenericParamter type.
+Static bool for determining if a type T is a supported GenericParameters type.
@@ -867,7 +868,7 @@ Namespace podio
Public Functions
@@ -905,7 +906,7 @@ Namespace podio
collType – The collection type name (e.g. from collection->getTypeName())
version – The schema version the created buffers should have
-susbsetColl – Should the buffers be for a subset collection or not
+subsetColl – Should the buffers be for a subset collection or not
Returns:
@@ -1667,7 +1668,7 @@ Namespace podio
inline void setValue(const std::string &key, std::vector<std::string> values)
-Overlaod for catching initializer list setting of string vector values.
+Overload for catching initializer list setting of string vector values.
@@ -2050,7 +2051,7 @@ Namespace podio
-
std::vector<std::string_view> getAvailableCategories() const
-Get the names of all the availalable Frame categories in the current file(s)
+Get the names of all the available Frame categories in the current file(s)
@@ -2198,7 +2199,7 @@ Namespace podio
-
std::vector<std::string_view> getAvailableCategories() const
-Get the names of all the availalable Frame categories in the current file(s)
+Get the names of all the available Frame categories in the current file(s)
@@ -2430,12 +2431,12 @@ Namespace podio
void registerEvolutionFunc(const std::string &collType, SchemaVersionT fromVersion, SchemaVersionT currentVersion, const EvolutionFuncT &evolutionFunc, Priority priority = Priority::UserDefined)
-Register an evoution function for a given collection type and given versions from where to where the evolution applies.
+Register an evolution function for a given collection type and given versions from where to where the evolution applies.
Several assumptions are in place here:
The current version has to be the same for all invocations for a given datatype.
An evolution function has to be registered for all possible versions from 1 to N - 1, where N is the current version
-An evolution function can only be registerd once for a given datatype and fromVersion
+An evolution function can only be registered once for a given datatype and fromVersion
For auto generated code the passed in priority has to be AutoGenerated otherwise it might override user defined functions
Even if a datatype does not require schema evolution it has to register an evolution function (e.g. the noOpSchemaEvolution below) in order to be known to the internal map.
@@ -2446,7 +2447,7 @@ Namespace podio
std::vector<std::string_view> getAvailableCategories() const
-Get the names of all the availalable Frame categories in the current file(s)
+Get the names of all the available Frame categories in the current file(s)
@@ -3073,7 +3074,7 @@ Namespace podio
-
std::vector<std::string_view> getAvailableCategories() const
-Get the names of all the availalable Frame categories in the current file(s)
+Get the names of all the available Frame categories in the current file(s)
@@ -3238,7 +3239,7 @@ Namespace podio
inline UserDataCollection(std::vector<BasicType> &&vec)
-Constructor from an existing vector (wich will be moved from!)
+Constructor from an existing vector (which will be moved from!)
@@ -3353,7 +3354,7 @@ Namespace podio
-
inline virtual void setSubsetCollection(bool) override
-declare this collection to be a subset collectionv - no effect
+declare this collection to be a subset collection - no effect
@@ -3474,7 +3475,7 @@ Namespace podio
-
constexpr const auto Metadata = "metadata"
-The metadata cateogry that is used to store a single Frame that holds data that is valid for a whole file, e.g.
+The metadata category that is used to store a single Frame that holds data that is valid for a whole file, e.g.
collection level parameters
@@ -3589,7 +3590,7 @@ Namespace podiotemplate<typename T>
class MaybeSharedPtr
#include <podio/utilities/MaybeSharedPtr.h>
-“Semi-smart” pointer class for pointers that at some point during their lifetime might hand over management to another entitity.
+“Semi-smart” pointer class for pointers that at some point during their lifetime might hand over management to another entity.
E.g. Objects that are added to a collection will hand over the management of their Obj* to collection. In such a case two things need to be considered:
Other Objects with the same Obj* instance should not delete the managed Obj*, even if the last Object goes out of scope
Even if the managed Obj* is gone (e.g. collection has gone out of scope or was cleared), the remaining Object instances should still be able to gracefully destruct, even if they are at this point merely an “empty husk” The MaybeSharedPtr achieves this by having an optional control block that controls the lifetime of itself and potentially the managed Obj*.
diff --git a/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1_category.html b/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1_category.html
index 48da700c0..f3165d7d8 100644
--- a/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1_category.html
+++ b/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1_category.html
@@ -402,6 +402,7 @@
podio.base_writer module
@@ -557,7 +558,7 @@ Namespace podio::Category
constexpr const auto Metadata = "metadata"
-The metadata cateogry that is used to store a single Frame that holds data that is valid for a whole file, e.g.
+The metadata category that is used to store a single Frame that holds data that is valid for a whole file, e.g.
collection level parameters
diff --git a/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1root__utils.html b/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1root__utils.html
index 7329d67f3..1be059005 100644
--- a/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1root__utils.html
+++ b/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1root__utils.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1sio__helpers.html b/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1sio__helpers.html
index e2eb1ed67..5a661150b 100644
--- a/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1sio__helpers.html
+++ b/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1sio__helpers.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1utils.html b/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1utils.html
index 115a52cfb..b561b67a6 100644
--- a/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1utils.html
+++ b/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1utils.html
@@ -402,6 +402,7 @@
podio.base_writer module
@@ -560,7 +561,7 @@ Namespace podio::utilstemplate<typename T>
class MaybeSharedPtr
#include <podio/utilities/MaybeSharedPtr.h>
-“Semi-smart” pointer class for pointers that at some point during their lifetime might hand over management to another entitity.
+“Semi-smart” pointer class for pointers that at some point during their lifetime might hand over management to another entity.
E.g. Objects that are added to a collection will hand over the management of their Obj* to collection. In such a case two things need to be considered:
Other Objects with the same Obj* instance should not delete the managed Obj*, even if the last Object goes out of scope
Even if the managed Obj* is gone (e.g. collection has gone out of scope or was cleared), the remaining Object instances should still be able to gracefully destruct, even if they are at this point merely an “empty husk” The MaybeSharedPtr achieves this by having an optional control block that controls the lifetime of itself and potentially the managed Obj*.
diff --git a/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1version.html b/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1version.html
index 2203fded9..a1212187c 100644
--- a/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1version.html
+++ b/docs-on-gh-pages/cpp_api/namespace/namespacepodio_1_1version.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/namespace/namespacesio.html b/docs-on-gh-pages/cpp_api/namespace/namespacesio.html
index ff6070af8..8b4e7a296 100644
--- a/docs-on-gh-pages/cpp_api/namespace/namespacesio.html
+++ b/docs-on-gh-pages/cpp_api/namespace/namespacesio.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/namespacelist.html b/docs-on-gh-pages/cpp_api/namespacelist.html
index 939831d12..922b9307f 100644
--- a/docs-on-gh-pages/cpp_api/namespacelist.html
+++ b/docs-on-gh-pages/cpp_api/namespacelist.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_collection_read_buffers.html b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_collection_read_buffers.html
index 95da78332..ce2d5dc56 100644
--- a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_collection_read_buffers.html
+++ b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_collection_read_buffers.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_collection_write_buffers.html b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_collection_write_buffers.html
index b32b10183..1ffb561b5 100644
--- a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_collection_write_buffers.html
+++ b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_collection_write_buffers.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_frame_1_1_frame_concept.html b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_frame_1_1_frame_concept.html
index 665f48194..8caa45b73 100644
--- a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_frame_1_1_frame_concept.html
+++ b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_frame_1_1_frame_concept.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_frame_1_1_frame_model.html b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_frame_1_1_frame_model.html
index be5649dd9..208930930 100644
--- a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_frame_1_1_frame_model.html
+++ b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_frame_1_1_frame_model.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_r_o_o_t_frame_reader_1_1_category_info.html b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_r_o_o_t_frame_reader_1_1_category_info.html
index ca660b107..14d3f2210 100644
--- a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_r_o_o_t_frame_reader_1_1_category_info.html
+++ b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_r_o_o_t_frame_reader_1_1_category_info.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_r_o_o_t_frame_writer_1_1_category_info.html b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_r_o_o_t_frame_writer_1_1_category_info.html
index 74aa3d628..62155ae5d 100644
--- a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_r_o_o_t_frame_writer_1_1_category_info.html
+++ b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_r_o_o_t_frame_writer_1_1_category_info.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_r_o_o_t_n_tuple_reader_1_1_collection_info.html b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_r_o_o_t_n_tuple_reader_1_1_collection_info.html
index 1ac6ad83b..e831cdeb0 100644
--- a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_r_o_o_t_n_tuple_reader_1_1_collection_info.html
+++ b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_r_o_o_t_n_tuple_reader_1_1_collection_info.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_r_o_o_t_n_tuple_writer_1_1_collection_info.html b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_r_o_o_t_n_tuple_writer_1_1_collection_info.html
index deb66eb75..b745e8b51 100644
--- a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_r_o_o_t_n_tuple_writer_1_1_collection_info.html
+++ b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_r_o_o_t_n_tuple_writer_1_1_collection_info.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_relation_names.html b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_relation_names.html
index ab9ed894f..4d0564e35 100644
--- a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_relation_names.html
+++ b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_relation_names.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_s_i_o_file_t_o_c_record_block.html b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_s_i_o_file_t_o_c_record_block.html
index 0eebc60a1..3d3c7f1d6 100644
--- a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_s_i_o_file_t_o_c_record_block.html
+++ b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_s_i_o_file_t_o_c_record_block.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_s_i_o_map_block.html b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_s_i_o_map_block.html
index 916d46fb2..12be6c58a 100644
--- a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_s_i_o_map_block.html
+++ b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_s_i_o_map_block.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_s_i_o_version_block.html b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_s_i_o_version_block.html
index ec7a77105..879022b90 100644
--- a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_s_i_o_version_block.html
+++ b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_s_i_o_version_block.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_schema_evolution_1_1_map_index.html b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_schema_evolution_1_1_map_index.html
index e610ab56f..53121e6c4 100644
--- a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_schema_evolution_1_1_map_index.html
+++ b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1_schema_evolution_1_1_map_index.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1root__utils_1_1_collection_branches.html b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1root__utils_1_1_collection_branches.html
index 056ab76fc..665b13d61 100644
--- a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1root__utils_1_1_collection_branches.html
+++ b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1root__utils_1_1_collection_branches.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1utils_1_1_maybe_shared_ptr_1_1_control_block.html b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1utils_1_1_maybe_shared_ptr_1_1_control_block.html
index 421d36d86..17371303c 100644
--- a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1utils_1_1_maybe_shared_ptr_1_1_control_block.html
+++ b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1utils_1_1_maybe_shared_ptr_1_1_control_block.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1version_1_1_version.html b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1version_1_1_version.html
index 1ca9b686d..c3f045ed3 100644
--- a/docs-on-gh-pages/cpp_api/struct/structpodio_1_1version_1_1_version.html
+++ b/docs-on-gh-pages/cpp_api/struct/structpodio_1_1version_1_1_version.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/cpp_api/structlist.html b/docs-on-gh-pages/cpp_api/structlist.html
index 7fbca443c..a93ee9c71 100644
--- a/docs-on-gh-pages/cpp_api/structlist.html
+++ b/docs-on-gh-pages/cpp_api/structlist.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/datamodel_syntax.html b/docs-on-gh-pages/datamodel_syntax.html
index 7fee95897..7d8c5b38b 100644
--- a/docs-on-gh-pages/datamodel_syntax.html
+++ b/docs-on-gh-pages/datamodel_syntax.html
@@ -402,6 +402,7 @@
podio.base_writer module
@@ -677,7 +678,7 @@ Global options
Extending a datamodel / using types from an upstream datamodel
It is possible to extend another datamodel with your own types, resp. use some datatypes or components from an upstream datamodel in your own datamodel.
-This can be useful for prototyping new datatypes or for accomodating special requirements without having to reimplement / copy a complete datamodel.
+This can be useful for prototyping new datatypes or for accommodating special requirements without having to reimplement / copy a complete datamodel.
To pass an upstream datamodel to the class generator use the --upstream-edm
option that takes the package name as well as the yaml definition file of the upstream datamodel separated by a colon (‘:’).
This will effectively make all components and datatypes of the upstream datamodel available to the current definition for validation and generation of the necessary includes.
Nevertheless, only the code for the datatypes and components defined in the current yaml file will be generated.
diff --git a/docs-on-gh-pages/design.html b/docs-on-gh-pages/design.html
index 04dae9aae..a57241cf1 100644
--- a/docs-on-gh-pages/design.html
+++ b/docs-on-gh-pages/design.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/doc.html b/docs-on-gh-pages/doc.html
index 46e955c3e..720a7c644 100644
--- a/docs-on-gh-pages/doc.html
+++ b/docs-on-gh-pages/doc.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/doc_title.html b/docs-on-gh-pages/doc_title.html
index b405998d1..8c67ac366 100644
--- a/docs-on-gh-pages/doc_title.html
+++ b/docs-on-gh-pages/doc_title.html
@@ -400,6 +400,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/examples.html b/docs-on-gh-pages/examples.html
index fb2d6e0a9..04ec73084 100644
--- a/docs-on-gh-pages/examples.html
+++ b/docs-on-gh-pages/examples.html
@@ -402,6 +402,7 @@
podio.base_writer module
@@ -536,7 +537,7 @@
Examples for Supported Interface
The following snippets show the support of PODIO for the different use cases as
well as some potential pitfalls. These examples are mainly concerned with how
-collections of objects and the objects themselve interact. As such they are
+collections of objects and the objects themselves interact. As such they are
framework agnostic.
Object Ownership
@@ -589,7 +590,7 @@ Object References auto hit = cluster.Hits(<aNumber>);
-If asking for an entry outside bounds, a std::out_of_range exception is thrown.
+If asking for an entry outside bounds, a std::out_of_range
exception is thrown.
Looping through Collections
diff --git a/docs-on-gh-pages/frame.html b/docs-on-gh-pages/frame.html
index a933c4250..da57f46a4 100644
--- a/docs-on-gh-pages/frame.html
+++ b/docs-on-gh-pages/frame.html
@@ -402,6 +402,7 @@
podio.base_writer module
diff --git a/docs-on-gh-pages/genindex.html b/docs-on-gh-pages/genindex.html
index e927ec72b..9ee12ca3a 100644
--- a/docs-on-gh-pages/genindex.html
+++ b/docs-on-gh-pages/genindex.html
@@ -399,6 +399,7 @@
podio.base_writer module
@@ -559,6 +560,8 @@ Index
A