Moves __init__ docstrings to class docstrings and removes __init__ from docs, add missing docstrings, and general cleanup#2452
Conversation
Codecov Report
@@ Coverage Diff @@
## main #2452 +/- ##
=======================================
- Coverage 99.7% 99.7% -0.0%
=======================================
Files 283 283
Lines 25574 25568 -6
=======================================
- Hits 25472 25466 -6
Misses 102 102
Continue to review full report at Codecov.
|
angela97lin
changed the title
| # lower than MethodDocumenter so this is not chosen for normal methods | ||
| priority = 0.6 | ||
|
|
||
| def autodoc_skip_member(app, what, name, obj, skip, options): |
There was a problem hiding this comment.
Hide private methods and attributes
angela97lin
requested review from
ParthivNaresh,
bchen1116,
christopherbunn,
chukarsten,
dsherry,
freddyaboulton and
jeremyliweishih
freddyaboulton
left a comment
freddyaboulton
left a comment
There was a problem hiding this comment.
@angela97lin Thanks for adding all these missing docstrings! I think there are some init docstrings we can delete now but apart from that this LGTM!
bchen1116
left a comment
bchen1116
left a comment
There was a problem hiding this comment.
Wow, great work getting the docstrings all updated and cleaned up! This is huge, and the docs look real good.
Left a few comments on potential things to clean, but nothing blocking!
| class ColumnSelector(Transformer): | ||
| def __init__(self, columns=None, random_seed=0, **kwargs): | ||
| """Initalizes an transformer that drops specified columns in input data. | ||
| """ |
There was a problem hiding this comment.
Why do some lines have the quotes on one line and the description on the next, like the line here, while others are on the same line (like the description for SelectColumns on line 97)?
There was a problem hiding this comment.
Ah, I don't think there's a difference tbh :d
3 participants
Closes #2392
This PR does the following:
__init__docstrings to class docstrings and removes__init__from docs.Example of how this change looks on a specific class: https://feature-labs-inc-evalml--2452.com.readthedocs.build/en/2452/generated/evalml.pipelines.components.StackedEnsembleClassifier.html#evalml.pipelines.components.StackedEnsembleClassifier
vs main: https://evalml.alteryx.com/en/stable/generated/evalml.pipelines.components.StackedEnsembleClassifier.html