Skip to content

Conversation

@LennartPurucker
Copy link
Contributor

Make the README better!

@codecov-commenter
Copy link

codecov-commenter commented Oct 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.07%. Comparing base (7acfb6a) to head (6117f24).
Report is 6 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1361      +/-   ##
===========================================
- Coverage    84.58%   84.07%   -0.52%     
===========================================
  Files           38       38              
  Lines         5261     5305      +44     
===========================================
+ Hits          4450     4460      +10     
- Misses         811      845      +34     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@LennartPurucker
Copy link
Contributor Author

I suggest looking at the README in the branch instead of the PR diff.

Copy link
Collaborator

@PGijsbers PGijsbers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow Lennart 😱 that's amazing 🔥 our stars ⭐ are going 📈 !
But why do we stop at 12? 🤔 We can go all the way to 13! 🚀


If you use OpenML-Python in a scientific publication, we would appreciate a reference to the
following paper:
[Installation](https://openml.github.io/openml-python/main/#how-to-get-openml-for-python) | [Documentation](https://openml.github.io/openml-python) | [Contribution guidelines](https://github.com/openml/openml-python/blob/develop/CONTRIBUTING.md)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Contrib should maybe point to https://openml.github.io/openml-python/main/contributing.html, though that page is also 💩

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rather want to point to the github md

Copy link
Collaborator

@PGijsbers PGijsbers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🥇

@LennartPurucker LennartPurucker changed the title ReadME Rework First Version doc: README Rework Oct 15, 2024
@LennartPurucker LennartPurucker merged commit 8261a87 into develop Oct 15, 2024
10 of 12 checks passed
@LennartPurucker LennartPurucker deleted the LennartPurucker-patch-1 branch October 15, 2024 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants