Repository navigation
Stop documenting a return value and a parameter that do not exist - #1664
Venish Paneliya (VenishPaneliya) wants to merge 1 commit into
Conversation
DataTransformerTS.fit documents a Returns section listing processed X and y, but the method returns None; fit_transform is the one that returns the transformed data. norm_confusion_matrix documents an estimator parameter, but it only takes y_true and y_pred.
|
The It looks like the runner image rollout rather than this branch — #1661 hit the same failure on 2026-11-10 while other runs the same week passed. Happy to bump the The failing |
Why are these changes needed?
Two docstrings in
flaml/automldescribe things the code does not do:DataTransformerTS.fithas aReturns:section listing processedXandy, but the method returnsNone—fit_transformis the one that returns the transformed data, soX, y = transformer.fit(X, y)raises aTypeError.norm_confusion_matrixdocuments anestimatorparameter; its signature is(y_true, y_pred).Both are rendered into the API reference by pydoc-markdown. Docstrings only, no behaviour change.
Related issue number
None.
Checks
pre-commit-checkfails onmaintoo, see the comment below.