Repository navigation
Dataset functions are missing from documentation again #1035
Description
Description
When checking the docs for the OpenMLDataset object, only the constructor is documented - none of the operations:
https://openml.github.io/openml-python/develop/generated/openml.OpenMLDataset.html#openml.OpenMLDataset
E.g. dataset.get_data should be fully documented, and there are docstrings - they just don't show up in the docs:
https://github.com/openml/openml-python/blob/develop/openml/datasets/dataset.py#L653
Steps/Code to Reproduce
Check docs: https://openml.github.io/openml-python/develop/generated/openml.OpenMLDataset.html#openml.OpenMLDataset
(same problem for both master and develop)
Expected Results
Documentation on all operations.
Actual Results
Only the constructor is documented.
Activity
PGijsbers commentedon Mar 10, 2021
Agreed, with the remark that only public methods should be included (i.e. not those that are prefixed with an underscore).
PGijsbers commentedon Mar 15, 2021
OpenML classes derive some functionality from the
OpenMLBaseclass, e.g.push_tagandremove_tag,publishand so on. These should also be included in the API documentation.PGijsbers commentedon Apr 9, 2021
Fixed in #1044