euroargodev / euroargodev/argopy
Update documentation for OWC
- Dominant language
- Python
- Stars
- 229
- Forks
- 52
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 8
Description
I think the documentation section on OWC:
https://argopy.readthedocs.io/en/latest/advanced-tools/quality_control/salinity.html
needs to be updated for a better integration with the JSON config file of ``pyowc``:
```python
USER_CONFIG = owc.configuration.load() # fetch the default configuration and parameters
```
Contributor guide
Research direction
Start with the OWC section on the linked salinity documentation page and review the shown pyowc USER_CONFIG loading example. Update the documentation to explain the integration with pyowc's JSON configuration file, and consider the work done when the example and surrounding guidance accurately describe that setup.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100