Docs improvement #67
Open
Docs improvement #67
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Love the project!
I have tested it a while back but when I came back to the project yesterday I had a hard time remembering if it was hosted on PyPI or not from the README. When checking the README I failed to spot how to install, which is the first line here.
To make it easier for the user, I would recommend separating the installation and the Usage sections and write:
instead of just
pip install keras-unet-collection, which I believe is more standard and easier for the reader to see. In the README installation, I also reminded the user that the project is hosted on the PyPI.When making the PR, I also noticed some minor inconsistencies and SSIM not being properly defined. I made adjustments for that as well.
You can see how the final README looks in my fork here.