Some minor doc updates

NOAA-GFDL · Dec 3, 2024 · 004fbf7 · 004fbf7
1 parent 038de4d
commit 004fbf7
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/doc/background.rst b/doc/background.rst
@@ -3,7 +3,7 @@ Background
 
 The catalog builder project is a “python community package ecosystem” that allows you to generate data catalogs compatible with intake-esm.  Available as a Conda package. 
 
-See our `Github repository here <https://github.com/aradhakrishnanGFDL/CatalogBuilder>`_.
+See our `Github repository here <https://github.com/NOAA-GFDL/CatalogBuilder>`_.
 We have contributing guidelines and code of conduct documented in our GitHub repo. We welcome your contributions. 
 
 Brief overview on data catalogs 

diff --git a/doc/generation.rst b/doc/generation.rst
@@ -98,7 +98,7 @@ Catalog headers (column names) are set with the *HEADER LIST* variable. The *OUT
                   "member_id", "grid_label", "variable_id",
                   "time_range", "chunk_freq","platform","dimensions","cell_methods","standard_name","path"]
 
-The headerlist is expected column names in your catalog/csv file. This is usually determined by the users in conjuction
+The headerlist contains the expected column names of your catalog/csv file. This is usually determined by the users in conjuction
 with the ESM collection specification standards and the appropriate workflows.
 
 .. code-block:: yaml
@@ -183,5 +183,6 @@ _____
 
 .. Reference `Flags`_.
 
-- overwrite - Overwrite an existing catalog at the given output path
-- append - Append (without headerlist) to an existing catalog at the given output path
+- --overwrite - Overwrite an existing catalog at the given output path
+- --append - Append (without headerlist) to an existing catalog at the given output path
+- --slow - Activates slow mode which retrieves standard_name `(or long_name) where possible. **"Standard_name" must be in your output_path_template**
diff --git a/doc/index.rst b/doc/index.rst
@@ -11,7 +11,7 @@ The Catalog Builder API will collect building blocks necessary to build a data c
 
 Tested on posix file system, S3 and GFDL post-processed (select simulations, components) at this time. This repository has unit tests (pytest) and incorporated the same in GitHub Actions, when a PR is open or a push is initiated.
 
-See our `Github repository <https://github.com/aradhakrishnanGFDL/CatalogBuilder>`_ here.
+See our `Github repository <https://github.com/NOAA-GFDL/CatalogBuilder>`_ here.
 
 .. toctree::
    :maxdepth: 2