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

Reorder README sections and print dataframe #95

Merged
merged 10 commits into from Jan 29, 2024

Conversation

sgbaird
Copy link
Contributor

@sgbaird sgbaird commented Jan 22, 2024

I think it's better to get to the quick start sooner, and leave the more in-depth installation options towards the end.

I also think it might be worth using code formatting for the df output. For some reason, when I initially went through the docs I was under the impression there weren't any outputs (this was the case when I ran the code in Colab).

@CLAassistant
Copy link

CLAassistant commented Jan 22, 2024

CLA assistant check
All committers have signed the CLA.

@Scienfitz Scienfitz added the documentation Improvements or additions to documentation label Jan 23, 2024
README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@AVHopp AVHopp 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 very much for your contribution! I have some minor comments, the only one I consider critical is the link that directs to scikit-learn.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@AdrianSosic
Copy link
Collaborator

Hi @sgbaird, also from my side: thank you very much for all your input (especially the detailed feedback you gave in the issue you created).

To proceed with this PR, I've pushed some changes on top, fixing the issues raised by my colleagues and also slightly adjusting the installation part a bit further (e.g. the extra dependencies are not strictly needed for the user guide example).

Let me know if you have any further comments. Otherwise, I'll merge by the end of the day. If you encounter more things you prefer to have changed, we can always open another PR 👍🏼

@AdrianSosic
Copy link
Collaborator

@AVHopp @Scienfitz, could you please re-check and approve if OK?

@AdrianSosic AdrianSosic changed the title rename to advanced installation and move to end, code output for DF Reorder README sections and print dataframe Jan 26, 2024
Copy link
Collaborator

@AVHopp AVHopp left a comment

Choose a reason for hiding this comment

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

Just found one missing word.

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@AdrianSosic
Copy link
Collaborator

@sgbaird: would you like to put your name and affiliation to CONTRIBUTORS.md? Can wait with the merge ...

@sgbaird
Copy link
Contributor Author

sgbaird commented Jan 27, 2024

You're welcome! Thank you for reviewing the changes and making edits 😊 Also, I updated the contributors file, but feel free to adjust.

It's clear to me there has been a lot of work into making this a high-quality tool! I will try to loop back to the other items soon

@AdrianSosic
Copy link
Collaborator

Great, thanks for adding your name. Will merge now 🚀

@AdrianSosic AdrianSosic merged commit 50e7dc3 into emdgroup:main Jan 29, 2024
9 checks passed
@sgbaird sgbaird deleted the patch-2 branch January 29, 2024 16:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants