HydrologicEngineeringCenter / HydrologicEngineeringCenter/cwms-python
Description and usage of version is incorrect
- Dominant language
- Python
- Stars
- 16
- Forks
- 11
- Avg merge
- 4d 6h
- Merged PRs (30d)
- 8
Description
The statements within https://github.com/HydrologicEngineeringCenter/cwms-python/blob/18b34b037ce32523ecdee287005c9219a1216e27/cwms/api.py#L141 are incorrect.
While CDA overall does have a version (the calendar data of release) the API itself is not versioned.
Data is versioned in the case of backwards incompatible changes.
This method and it's descriptive text imply the entire API is versioned - this is not correct.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open cwms/api.py at line 141 and compare the method's statements with the issue's distinction between CDA release version and API/data versioning. Check linked pull request #319 for the work already underway; done means the method and its descriptive text no longer imply that the entire API is versioned.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100