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

Updates example section in the Readme #48

Merged
merged 15 commits into from
Oct 30, 2024

Conversation

Trybnetic
Copy link

As outlined in #47, this PR updates the documentation in the readme. Specifically, I made the examples consistent in the sense that they are both using the fruits.txt dataset now and extended the descriptions of the examples a bit.

Changes introduced in this PR:

  • Consistent use of fruits.txt in the examples
  • Extended descriptions of the examples
  • Overview of the function and its parameters in the readme
  • Updated the CI status badge

I see some further changes that could be included in this PR:

  • Clean up (e.g. the no longer used PNGs, the deprecated arguments mentioned in the readme, etc.)
  • Longer explanation on the use of leftWeight and rightWeight

@Pierre-Sassoulas
Copy link
Owner

Hey @Trybnetic, is this still a work in progress ?

@Trybnetic
Copy link
Author

I actually struggled with explaining on the use of leftWeight and rightWeight, but I will try the next days to do the mentioned clean up and then this PR should be ready to be merged.

@Trybnetic Trybnetic marked this pull request as ready for review October 21, 2024 11:11
Copy link
Owner

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

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

Thank you, made some suggestions, let me know what you think and let's merge this.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Trybnetic and others added 3 commits October 30, 2024 12:08
Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
@Trybnetic
Copy link
Author

Both suggestions look very good to me! Thanks for the proof-read!

@Pierre-Sassoulas Pierre-Sassoulas merged commit 14a58b1 into Pierre-Sassoulas:main Oct 30, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants