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
I have set all docstrings to wip in #1201 to trick pydocstyle into accepting the PR, they should be updated with actual info about the classes and methods.
Hi @OriolAbril , I have commented my view on #1574 , If it got assigned , I would like to update the information about the functions in the docstrings by referring to the documentation, and please let me know if this is a straight updation or anything else need to keep in mind if I got assigned with #1574
I don't think I understand, sorry. You can work on the docstrings too if you want to work on both tests and docstrings.
The way to go about updating the docstrings would be to start by reading the label guide, and then start with the docstrings. The first one should be the docstrings for the class and methods of BaseLabeller, this one should be detailed and explian what does each method do. And then move to the others. As you have seen, the other classes only implement one or two methods, all the rest are inherited from BaseLabeller, both methods and docstrings will be inherited so the documentation will show everything automatically. It is therefore important to list in the class docstring which methods are the ones that are overwriten by the class. Then in the docstrings of the methods, describe how they differ from the ones in BaseLabeller. Examples are not really important in any of the docstrings, I believe the label guide covers it.
Some extra requirements:
All classes should link to the label guide
All classes except BaseLabeller need a "See Also" section listing at least BaseLabeller and optionally related labellers (IdxLabeller is related to DimIdxLabeller and viceversa, DimCoordLabeller to DimIdxLabeller and viceversa...)
I have set all docstrings to
wip
in #1201 to trick pydocstyle into accepting the PR, they should be updated with actual info about the classes and methods.Related to #1574
Notes
There is a label guide available at the docs.
The text was updated successfully, but these errors were encountered: