Skip to content

Commit

Permalink
Fix some small doc issues
Browse files Browse the repository at this point in the history
  • Loading branch information
dnowacki-usgs committed Jan 15, 2024
1 parent 5f5b23b commit da21e1b
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
7 changes: 3 additions & 4 deletions doc/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,6 @@ When an RBR instrument is used in ``CONTINUOUS`` mode as a profiling instrument

- ``featureType: 'profile'``: this `CF-compliant <https://cfconventions.org/cf-conventions/cf-conventions.html#profile-data>`_ ``featureType`` instructs stglib to process these data as a profile dataset.
- ``latitude: [36.959, 41.533, 27.764]``, ``longitude: [-122.056, -70.651, -82.638]``: these values can each be specified as a YAML list of latitudes and longitudes, each element in the lists corresponding to a profile.
27.764, -82.638
- ``split_profiles``: when set to `True`, split a multi-profile dataset into individual netCDF files for each profile

EXO
Expand Down Expand Up @@ -185,10 +184,10 @@ Sontek IQ
- ``channel_cross_section_note``: note specifying starting bank (left or right) for RTK transect across the channel and when the transect measurements were collected (optional, recommended)

Onset Hobo
---------
----------

- All the _min, _max, _bad_ens, etc. options available to the EXO.
- ``instrument_type``: can be ``hwl`` (water level), ``hwlb`` (water level as barometer), ``hdo`` (dissolved oxygen) or ``hcnd``(conductivity) use these based on parameter measured by hobo logger
- ``instrument_type``: can be ``hwl`` (water level), ``hwlb`` (water level as barometer), ``hdo`` (dissolved oxygen) or ``hcnd`` (conductivity) use these based on parameter measured by hobo logger
- ``skipfooter``: number of lines to skip in the CSV file at the end of the file
- ``ncols``: number of columns of data to read, starting at first
- ``names``: option for user specified column names (only recommended when code will read names using automated/default method)
- ``names``: option for user specified column names (only recommended when code will read names using automated/default method)
13 changes: 12 additions & 1 deletion doc/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,22 @@ Contributing to stglib
which in turn came from the `Pandas Contributing
Guide <http://pandas.pydata.org/pandas-docs/stable/contributing.html>`_.

Overview
========

We welcome your skills and enthusiasm! There are numerous opportunities to
contribute beyond just writing code.
All contributions, including bug reports, bug fixes, documentation improvements, enhancement suggestions,
and other ideas are welcome.

Where to start?
===============

We need your help. All contributions, bug reports, bug fixes, documentation improvements,
enhancements, and ideas are welcome.

If you are brand new to open-source development, we recommend going
through the `stglib's GitHub "issues" tab <https://github.com/USGS-CMG/stglib/issues>`_
through `stglib's GitHub "issues" tab <https://github.com/USGS-CMG/stglib/issues>`_
to find issues that interest you, discuss issues, to report new issues or propose new features.


Expand All @@ -29,6 +37,9 @@ to find issues that interest you, discuss issues, to report new issues or propos
Bug reports and enhancement requests
====================================

Bug reports are an important part of making *stglib* more stable. Having a complete bug
report will allow others to reproduce the bug and provide insight into fixing.

To indicate desire to work on an issue, post your intent and ideas in the issues tab.
Follow the guidance here to set up your environment in python.

Expand Down

0 comments on commit da21e1b

Please sign in to comment.