Documentation error for DataArray.pad
Open
Beginner friendly
Nobody has claimed this yet.
bug
needs triage
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
What happened?
The documentation for DataArray.pad says that the default value for constant_values is zero. But in the source the default value is None -- this value is passed to Dataset.pad, which converts it to nan, as described in the documentation for Dataset.pad.
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
Start with the linked DataArray.pad documentation and the DataArray.pad source or docstring mentioned in the report. Compare its constant_values description with Dataset.pad, then correct the documented default so it matches the implementation and resulting nan behavior. Verify that the generated DataArray.pad documentation reflects the corrected wording.
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
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 82/100