Merge pull request #2 from swerik-project/dev

prerelease: patch version

Author: BobBorges

CITATION.cff

@@ -1,7 +1,7 @@
 cff-version: 1.2.0
 message: To cite this reposository, please use these metadata.
 title: "valtiopy: access the Finnish Parliament Corpus"
-version: v0.0.1
+version: v0.0.2
 authors:
   - family-names: Borges
     given-names: Robert

docs/search.js

@@ -22,6 +22,11 @@
             <input type="search" placeholder="Search..." role="searchbox" aria-label="search"
                    pattern=".+" required>
 
+            <h2>Contents</h2>
+            <ul>
+  <li><a href="#valtiopy">valtiopy</a></li>
+</ul>
+
 
             <h2>Submodules</h2>
             <ul>
@@ -32,7 +37,7 @@ <h2>Submodules</h2>
             </ul>
 
 
-            <footer>v0.0.1</footer>
+            <footer>v0.0.2</footer>
 
         <a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
             built with <span class="visually-hidden">pdoc</span><img
@@ -46,10 +51,21 @@ <h2>Submodules</h2>
                     <h1 class="modulename">
 valtiopy    </h1>
 
-                
-                
-                
-                
+                        <div class="docstring"><h1 id="valtiopy">valtiopy</h1>
+
+<p>A Python module for working with the Valtiopaivat corpus.</p>
+</div>
+
+                        <input id="mod-valtiopy-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
+
+                        <label class="view-source-button" for="mod-valtiopy-view-source"><span>View Source</span></label>
+
+                        <div class="pdoc-code codehilite"><pre><span></span><span id="L-1"><a href="#L-1"><span class="linenos">1</span></a><span class="sd">&quot;&quot;&quot;</span>
+</span><span id="L-2"><a href="#L-2"><span class="linenos">2</span></a><span class="sd">.. include:: ../README.md</span>
+</span><span id="L-3"><a href="#L-3"><span class="linenos">3</span></a><span class="sd">&quot;&quot;&quot;</span>
+</span></pre></div>
+
+
             </section>
     </main>
 <script>

docs/valtiopy.html

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "valtiopy"
-version = "v0.0.1"
+version = "v0.0.2"
 description = "Work with the Valtiopaivat Corpus."
 authors = ["bobborges"]
 repository = "https://github.com/swerik-project/valtiopy"

docs/valtiopy/args.html

@@ -0,0 +1,3 @@
+"""
+.. include:: ../README.md
+"""

docs/valtiopy/config.html

@@ -39,6 +39,14 @@ def custom_serializer(obj):
 def populate_common_args(parser):
     """
     Add common arguments to a parser that will be used in most of the scripts.
+
+    Args
+
+        parser: argparse parser instance
+
+    Returns
+
+        parser
     """
     parser.add_argument("-c", "--config-name",
                         default = 'default',
@@ -85,6 +93,14 @@ def populate_common_args(parser):
 def fetch_parser(description=None):
     """
     Create a parser instance and populate it with common arguments.
+
+    Args
+
+        description (str): description of script calling parser (__doc__)
+
+    Returns
+
+        parser
     """
     parser = argparse.ArgumentParser(description=description)
     parser = populate_common_args(parser)
@@ -94,6 +110,14 @@ def fetch_parser(description=None):
 def impute_arg_values(args):
     """
     parse common arguments and pre-handle args for the script user
+
+    Args
+
+        args: Argparse argument class instances
+
+    Returns
+
+        args
     """
     def _handle_config(args):
         """
@@ -114,6 +138,14 @@ def _handle_config(args):
     def _fetch_documents(args):
         """
         fetch documents according to start/end or meeting time frame
+
+        Args
+
+            args: Argparse argument class instances
+
+        Returns
+
+            args
         """
         def _get_files(paths, args, ext=".xml"):
             files = []
@@ -156,6 +188,14 @@ def _get_files(paths, args, ext=".xml"):
     def _filter_doctype(args):
         """
         select documents based on doctype
+
+        Args
+
+            args: Argparse argument class instances
+
+        Returns
+
+            args
         """
         if args.doctypes is None:
             return args
@@ -172,13 +212,29 @@ def _filter_doctype(args):
     def _filter_language(args):
         """
         select documents based on the primary language
+
+        Args
+
+            args: Argparse argument class instances
+
+        Returns
+
+            args
         """
         warnings.warn(_filter_language.__name__, NotImplemented)
         return args
 
     def _filter_chamber(args):
         """
         select documents based on the chamber
+
+        Args
+
+            args: Argparse argument class instances
+
+        Returns
+
+            args
         """
         if args.chambers is None:
             return args