Document units for polyfit when dimension is time
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
Is your feature request related to a problem? Please describe.
I think (please correct me if I'm wrong) when using polyfit with dim='time' the units of the output slope are [data_units]/ns, but this not explained in the docstring or in the documentation on the webpage. I figured this out eventually but it could be confusing for new users.
Describe the solution you'd like
Mention in the documentation and/or docstring that the units for time will be ns
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
Locate the polyfit docstring and the related webpage documentation in the xarray repository. Confirm how polyfit handles dim="time", document that time-based slope units use nanoseconds, and verify the rendered documentation or documentation checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100