Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dataset functions are missing from documentation again #1035

Closed
joaquinvanschoren opened this issue Mar 9, 2021 · 3 comments
Closed

Dataset functions are missing from documentation again #1035

joaquinvanschoren opened this issue Mar 9, 2021 · 3 comments
Labels
Documentation Good First Issue Issues suitable for people new to contributing to openml-python!

Comments

@joaquinvanschoren
Copy link
Contributor

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.

@PGijsbers PGijsbers added Documentation Good First Issue Issues suitable for people new to contributing to openml-python! labels Mar 10, 2021
@PGijsbers
Copy link
Collaborator

Agreed, with the remark that only public methods should be included (i.e. not those that are prefixed with an underscore).

@PGijsbers
Copy link
Collaborator

OpenML classes derive some functionality from the OpenMLBase class, e.g. push_tag and remove_tag, publish and so on. These should also be included in the API documentation.

@PGijsbers
Copy link
Collaborator

Fixed in #1044

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Good First Issue Issues suitable for people new to contributing to openml-python!
Projects
None yet
Development

No branches or pull requests

2 participants