Skip to content

Commit

Permalink
typo cleanup #770
Browse files Browse the repository at this point in the history
  • Loading branch information
lisagoodrich committed Apr 25, 2022
1 parent 11116cf commit 3d912c1
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
6 changes: 3 additions & 3 deletions docs/Contributors_Guide/add_use_case.rst
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ Input Data
Sample input data needed to run the use case should be provided. Please try to
limit the input data to the minimum that is
needed to demonstrate the use case effectively. GRIB2 files can be pared down
to only contain the fields and/or vertical levels that are needed using
to only contain the fields and/or vertical levels that are needed for using
`wgrib2 <https://www.cpc.ncep.noaa.gov/products/wesley/wgrib2/>`_.

Example: To create a file called subset.grib2 that only contains TMP data from
Expand Down Expand Up @@ -854,8 +854,8 @@ steps were unsuccessful in lowering memory usage, please take the following step
- In the *.github/parm/use_case_groups.json* file, remove the entry that
was added during the :ref:`add_new_category_to_test_runs`
for the new use case. This will stop the use case from running on a pull request.
- Push these two updated files to the branch in Github and confirm that it
now compiles successfully.
- Push these two updated files to the working branch in Github and
confirm that it now compiles successfully.
- During the :ref:`create-a-pull-request` creation, inform the reviewer of
the Github Actions failure. The reviewer should confirm the use case is
successful when run manually, that the memory profiler output confirms that
Expand Down
14 changes: 7 additions & 7 deletions docs/Contributors_Guide/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ Release Guide:
(e.g. **open_release_issue.rst, clone_project_repository.rst**, etc.)
may be common to multiple METplus components. These common steps
are located in the *release_steps* directory. However, a METplus
component may have different instructions from other componenets
component may have different instructions from other components
(e.g. For **METplus wrappers, update_version.rst,
create_release_extra.rst**, etc.). In this case, the instructions
that are specific to that component are located in a subdirectory
Expand All @@ -156,7 +156,7 @@ Release Guide:
Verification Datasets Guide:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* To add/modify any relevant datasets in attempt to create a
* To add/modify any relevant datasets in an attempt to create a
centralized catalogue of verification datasets to provide the model
verification community with relevant "truth" datasets. See the
`Verification Datasets Guide Overview <https://metplus.readthedocs.io/en/latest/Verification_Datasets/overview.html>`_
Expand All @@ -172,11 +172,11 @@ build and display the documentation. Read the Docs simplifies the
documentation process by building, versioning, and hosting the documentation.

Read the Docs supports multiple versions for each repository. For the METplus
compoents, the "latest" version will point to the latest official (stable)
components, the "latest" version will point to the latest official (stable)
release. The "develop" or "development" version will point to the most up to
date development code. There may also be other previous versions of the
software available in the version selector menu, which is accessible by
clicking in the bottom left corner of the the documentation pages.
clicking in the bottom left corner of the documentation pages.

Automation rules allow project maintainers to automate actions on new branches
and tags on repositories. For the METplus components, documentation is
Expand All @@ -199,8 +199,8 @@ view "feature_836_rtd_doc" for the METplus repository the URL would be:

The URL branch name will be lowercase regardless of the actual branch
letter casing,
i.e. "*feature_836_RTD_Doc*" branch would be accessed by the above
mentioned URL.
i.e. "*feature_836_RTD_Doc*" branch would be accessed by the
above-mentioned URL.

Read the Docs will automatically delete the documentation for a feature
branch and a bugfix branch when the branch is deleted.
Expand Down Expand Up @@ -264,7 +264,7 @@ _______________________________________
The Doxygen tool is employed to create documentation from the source code.
This documentation is useful in generating details about the METplus wrapper
API (Application Programming Interface).
This is a useful reference for contributors to peruse prior to creating
This is a useful reference for contributors to pursue prior to creating
new METplus wrappers.
The Doxygen files located in the */path/to/METplus/docs/doxygen* directory
do **NOT** need to be modified and should not be modified.
Expand Down

0 comments on commit 3d912c1

Please sign in to comment.