Skip to content

Commit

Permalink
Typos in doc strings (#648)
Browse files Browse the repository at this point in the history
* fix typos

* one more
  • Loading branch information
elcarpenterNOAA authored Nov 4, 2024
1 parent 8b835f7 commit 9e89a25
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/sections/contributor_guide/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Please follow these guidelines when contributing to the documentation:
* In [[sub]sub]section titles, capitalize all "principal" words. In practice this usually means all words but articles (a, an, the), logicals (and, etc.), and prepositions (for, of, etc.). Always fully capitalize acronyms (e.g., YAML).
* Never capitalize proper names when their owners do not (e.g., write `"pandas" <https://pandas.pydata.org/>`_, not "Pandas", even at the start of a sentence) or when referring to a software artifact (e.g., write ``numpy`` when referring to the library, and "NumPy" when referring to the project).
* When referring to YAML constructs, `block` refers to an entry whose value is a nested collection of key/value pairs, while `entry` refers to a single key/value pair.
* When using the ``.. code-block::`` directive, align the actual code with the word ``code``. Also, when ``.. code-block::`` directives appear in bulleted or numberd lists, align them with the text following the space to the right of the bullet/number. For example:
* When using the ``.. code-block::`` directive, align the actual code with the word ``code``. Also, when ``.. code-block::`` directives appear in bulleted or numbered lists, align them with the text following the space to the right of the bullet/number. For example:

.. code-block:: text
Expand Down
2 changes: 1 addition & 1 deletion src/uwtools/api/rocoto.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ def realize(
If no input file is specified, ``stdin`` is read. A ``YAMLConfig`` object may also be provided
as input. If no output file is specified, ``stdout`` is written to. Both the input config and
output Rocoto XML will be validated against appropriate schcemas.
output Rocoto XML will be validated against appropriate schemas.
:param config: YAML input file or ``YAMLConfig`` object (``None`` => read ``stdin``).
:param output_file: XML output file path (``None`` => write to ``stdout``).
Expand Down
4 changes: 2 additions & 2 deletions src/uwtools/config/jinja2.py
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ def dereference(
values; render strings; convert values tagged with explicit types; and return objects of other
types unmodified. Rendering may fail for valid reasons -- notably a replacement value not being
available in the given context object. In such cases, return the original value: Any unrendered
Jinja2 syntax it contains may may be rendered by later processing with better context.
Jinja2 syntax it contains may be rendered by later processing with better context.
When rendering dict values, replacement values will be taken from, in priority order
1. The full context dict
Expand Down Expand Up @@ -335,7 +335,7 @@ def _supplement_values(
env: bool = False,
) -> dict:
"""
Optionally supplement values from given source with overrides and/or environment vairables.
Optionally supplement values from given source with overrides and/or environment variables.
:param values_src: Source of values to render the template.
:param values_format: Format of values when sourced from file.
Expand Down

0 comments on commit 9e89a25

Please sign in to comment.