Numpydoc validation - ignore setters
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
Excellent work on implementing the numpydoc validation as a pre-commit hook.
I've noticed that it is flagging getters and sellers. For example:
@property
def x(self) -> np.ndarray:
"""Return or set the coordinates along the X-direction.
Examples
--------
Return the x coordinates of a RectilinearGrid.
>>> import numpy as np
>>> import pyvista
>>> xrng = np.arange(-10, 10, 10, dtype=float)
>>> yrng = np.arange(-10, 10, 10, dtype=float)
>>> zrng = np.arange(-10, 10, 10, dtype=float)
>>> grid = pyvista.RectilinearGrid(xrng, yrng, zrng)
>>> grid.x
array([-10., 0.])
Set the x coordinates of a RectilinearGrid.
>>> grid.x = [-10.0, 0.0, 10.0]
>>> grid.x
array([-10., 0., 10.])
"""
return convert_array(self.GetXCoordinates())
@x.setter
def x(self, coords: Sequence):
self.SetXCoordinates(convert_array(coords))
self._update_dimensions()
self.Modified()
Is it possible to ignore the returns (RT01) of properties and the docstring all together of setters (GL08)?
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 numpydoc validation pre-commit hook and inspect how it handles properties and setters, focusing on the RT01 return and GL08 docstring checks. Done means property returns are ignored and setter docstrings are not required, with validation still reporting other applicable issues.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100