Reorder scribe_data docs dir and add spacing to fxn docstrings

scribe-org · Jan 20, 2025 · 97b4e90 · 97b4e90
1 parent ffc6f36
commit 97b4e90
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 6 deletions.
diff --git a/docs/source/scribe_data/index.rst b/docs/source/scribe_data/index.rst
@@ -3,16 +3,16 @@ Scribe-Data
 
 `View code on Github <https://github.com/scribe-org/Scribe-Data/tree/main/src/scribe_data>`_
 
+.. toctree::
+    :maxdepth: 1
+
+    cli
+    utils
+
 .. toctree::
     :maxdepth: 2
 
     load/index
     unicode/index
     wikidata/index
     wikipedia/index
-
-.. toctree::
-    :maxdepth: 1
-
-    cli
-    utils
diff --git a/docs/source/scribe_data/wikidata/index.rst b/docs/source/scribe_data/wikidata/index.rst
@@ -12,5 +12,6 @@ wikidata/
 .. toctree::
     :maxdepth: 1
 
+    format_data
     query_profanity
     query_data
diff --git a/src/scribe_data/cli/download.py b/src/scribe_data/cli/download.py
@@ -58,8 +58,10 @@ def available_closest_lexeme_dumpfile(
     ----------
     target_entity : str
         The target date for which the dump is requested (format: YYYY/MM/DD or similar).
+
     other_old_dumps : list
         List of available dump folders as strings.
+
     check_wd_dump_exists : function
         A function to validate if the dump file exists.
 

diff --git a/src/scribe_data/unicode/generate_emoji_keywords.py b/src/scribe_data/unicode/generate_emoji_keywords.py
@@ -29,6 +29,7 @@ def generate_emoji(language, output_dir: str = None):
     ----------
     language : str
         The ISO code of the language for which to generate emoji keywords.
+
     output_dir : str, optional
         The directory where the generated data will be saved.
         If not specified, the data will be saved in a default directory.

diff --git a/src/scribe_data/utils.py b/src/scribe_data/utils.py
@@ -108,6 +108,7 @@ def _load_json(package_path: str, file_name: str) -> Any:
     ----------
     package_path : str
         The fully qualified package that contains the resource.
+
     file_name : str
         The name of the file (resource) that contains the JSON data.
 
@@ -781,6 +782,7 @@ def get_language_iso_code(qid: str):
     ------
     ValueError
         An invalid QID that's not a language has been passed.
+
     KeyError
         The ISO code for the language is not available.
     """

diff --git a/src/scribe_data/wikidata/format_data.py b/src/scribe_data/wikidata/format_data.py
@@ -31,8 +31,10 @@ def format_data(
     ----------
     dir_path : str
         The output directory path for results.
+
     language : str
         The language for which the data is being loaded.
+
     data_type : str
         The type of data being loaded (e.g. 'nouns', 'verbs').
 

diff --git a/src/scribe_data/wikidata/query_data.py b/src/scribe_data/wikidata/query_data.py
@@ -31,8 +31,10 @@ def execute_formatting_script(output_dir: str, language: str, data_type: str):
     ----------
     output_dir : str
         The output directory path for results.
+
     language : str
         The language for which the data is being loaded.
+
     data_type : str
         The type of data being loaded (e.g. 'nouns', 'verbs').