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.

Sign up for GitHub

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

Jump to bottom

Attributes are not documented?! #716

Closed
amueller opened this issue Jun 19, 2019 · 4 comments · Fixed by #1307
Closed

Attributes are not documented?! #716

amueller opened this issue Jun 19, 2019 · 4 comments · Fixed by #1307
Labels
Documentation Good First Issue Issues suitable for people new to contributing to openml-python!

Comments

@amueller
Copy link
Contributor

It looks like none of the classes document their attributes. They really should.
@amueller amueller added Documentation Good First Issue Issues suitable for people new to contributing to openml-python! labels Jun 19, 2019
@PGijsbers
Copy link
Collaborator

Marcos will take this up! 🎉

@marcoslbueno marcoslbueno self-assigned this Jul 7, 2020
@v-parmar
Copy link
Contributor

v-parmar commented Feb 7, 2023

Hey @amueller, Can you give me some instructions about this issue?

@LennartPurucker
Copy link
Contributor

For documentation purposes, I found the following classes that are currently missing documentation as far as I can tell:

  • OpenMLRun (see PR Update run.py #1194)
  • OpenMLClusteringTask
  • OpenMLTask
  • OpenMLLearningCurveTask
  • OpenMLClassificationTask
  • OpenMLClassificationTask
  • OpenMLSplit

This was referenced Mar 27, 2023
Closed
Closed
Closed
Closed
Closed
This was referenced Aug 16, 2023
Closed
Merged
@v-parmar
Copy link
Contributor

Hey @amueller @LennartPurucker, I have added the missing documentation of the remaining attributes of classes and functions. Please check my PR(#1283) and tell me if any changes are required.

@eddiebergman eddiebergman mentioned this issue Jan 7, 2024
Open
@LennartPurucker LennartPurucker mentioned this issue Jan 9, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Good First Issue Issues suitable for people new to contributing to openml-python!
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Linting Everything - Fix All mypy and ruff Errors openml/openml-python
5 participants
@amueller @PGijsbers @marcoslbueno @v-parmar @LennartPurucker