You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We started to validate the formats of docstrings. For example, we expect that the summary of the docstring starts in the next line of the opening """ (see #24059).
In some cases the docstrings are generated dynamically, and in the case of _field_accessor, we have to write some line breaks to avoid the validation to fail, for example:
_field_accessor('year', 'Y', "\n The year of the datetime\n")
In this issue we should update the code of _field_accessor, and modify the calls to it removing the line breaks, so the previous example becomes:
_field_accessor('year', 'Y', 'The year of the datetime')
And the docstring is composed in a way that follows our docstring standards. The standards can be checked with:
which, it should report no error (or if it reports cases that are not fixed yet, the number of errors should decrease or not increase after the change).
The text was updated successfully, but these errors were encountered:
Not sure I understand. Your previous PR was good, it's better to fix this separate from all the other changes. And as it has already been merged, it can't be changed (if you push to your branch, nothing will be updated or happen)
We started to validate the formats of docstrings. For example, we expect that the summary of the docstring starts in the next line of the opening
"""
(see #24059).In some cases the docstrings are generated dynamically, and in the case of
_field_accessor
, we have to write some line breaks to avoid the validation to fail, for example:In this issue we should update the code of
_field_accessor
, and modify the calls to it removing the line breaks, so the previous example becomes:And the docstring is composed in a way that follows our docstring standards. The standards can be checked with:
which, it should report no error (or if it reports cases that are not fixed yet, the number of errors should decrease or not increase after the change).
The text was updated successfully, but these errors were encountered: