Updated pyauditor docs

ALU-Schumacher · Feb 9, 2023 · e0b46f0 · e0b46f0
1 parent 87b6df8
commit e0b46f0
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 3 deletions.
diff --git a/pyauditor/docs/conf.py b/pyauditor/docs/conf.py
@@ -9,7 +9,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'pyauditor'
-copyright = '2022, Stefan Kroboth'
+copyright = '2023, Stefan Kroboth'
 author = 'Stefan Kroboth'
 
 # -- General configuration ---------------------------------------------------

diff --git a/pyauditor/docs/examples.rst b/pyauditor/docs/examples.rst
@@ -29,7 +29,7 @@ Creating a Record
 
 .. code-block:: python
 
-   from pyauditor import Record, Component, Score
+   from pyauditor import Record, Meta, Component, Score
 
    # Define meta information
    record_id = "record-1" # Must be unique for all records in Auditor!
@@ -52,6 +52,15 @@ Creating a Record
    # Attach the component to the record
    record = record.with_component(component)
 
+   # Create meta 
+   meta = Meta()
+
+   # Add information to meta
+   meta = meta.insert("site_id", ["site1"])
+
+   # Attach meta to record
+   record = record.with_meta(meta)
+
    # Resource stopped being available
    stop = datetime.datetime(2021, 12, 6, 18, 0, 0, 79043) # in UTC
    record = record.with_stop_time(stop)

diff --git a/pyauditor/docs/index.rst b/pyauditor/docs/index.rst
@@ -14,7 +14,7 @@ It provides functionality to create records and send records to and receive reco
 Installation
 ============
 
-pyauditor requires a Python version >= 3.7.
+pyauditor requires a Python version >= 3.6.
 
 .. code-block::