From da21e1bf7c7fde0bc2d6971c5399703bfe25fba6 Mon Sep 17 00:00:00 2001 From: Dan Nowacki Date: Mon, 15 Jan 2024 12:33:48 -0800 Subject: [PATCH] Fix some small doc issues --- doc/config.rst | 7 +++---- doc/contributing.rst | 13 ++++++++++++- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/doc/config.rst b/doc/config.rst index 941ad94a..dcc7ddec 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -126,7 +126,6 @@ When an RBR instrument is used in ``CONTINUOUS`` mode as a profiling instrument - ``featureType: 'profile'``: this `CF-compliant `_ ``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 @@ -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) \ No newline at end of file +- ``names``: option for user specified column names (only recommended when code will read names using automated/default method) diff --git a/doc/contributing.rst b/doc/contributing.rst index 08504fd3..1c2141b0 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -13,6 +13,14 @@ Contributing to stglib which in turn came from the `Pandas Contributing Guide `_. +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? =============== @@ -20,7 +28,7 @@ We need your help. All contributions, bug reports, bug fixes, documentation imp enhancements, and ideas are welcome. If you are brand new to open-source development, we recommend going -through the `stglib's GitHub "issues" tab `_ +through `stglib's GitHub "issues" tab `_ to find issues that interest you, discuss issues, to report new issues or propose new features. @@ -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.