Skip to content

Commit

Permalink
Refer to package as HydroTools instead of Hydro tools in sphinx docs …
Browse files Browse the repository at this point in the history
…index.rst
  • Loading branch information
aaraney authored and AustinRaney-NOAA committed Apr 2, 2021
1 parent 157037a commit 0eccac2
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
``hydrotools``
``HydroTools``
=====================

Tools for retrieving hydrological data
Expand Down Expand Up @@ -49,15 +49,15 @@ What’s here?
------------

We’ve taken a grab-and-go approach to installation and usage of
Hydro tools. This means, in line with a standard toolbox, you will
Hydrotools. This means, in line with a standard toolbox, you will
typically install just the tool or tools that get your job done without
having to install all the other tools available. This means a lighter
installation load and that tools can be added to the toolbox, without
affecting your workflows!

It should be noted, we commonly refer to individual tools in hydro
tools as a subpackage or by their name (e.g. ``nwis_client``). You will
find this lingo in both issues and documentation.
It should be noted, we commonly refer to individual tools in HydroTools as a
subpackage or by their name (e.g. ``nwis_client``). You will find this lingo in both
issues and documentation.

Currently the repository has the following subpackages:

Expand Down Expand Up @@ -97,7 +97,7 @@ work just fine (``conda``, ``pipenv``, etc. ).
UTC Time
--------

Note: the canonical ``pandas.DataFrames`` used by hydrotools use
Note: the canonical ``pandas.DataFrames`` used by HydroTools use
time-zone naive datetimes that assume UTC time. In general, do not
assume methods are compatible with time-zone aware datetimes or
timestamps. Expect methods to transform time-zone aware datetimes and
Expand Down

0 comments on commit 0eccac2

Please sign in to comment.