Open
Conversation
Hi, I had an issue with multiprocessing that this library instantly solved. To thank you for your work, I've refactored the README to make it more appealing and readable. I followed what I think are best practices for drawing up readme files. Feel free to copy/paste what you like or discard my changes entirely. Best, Elias
Member
|
I actually like this change quite a lot. I don't like the icons/emoji at each heading, but there are some very nice stylistic changes here. One potential issue is that, when building the code, I read the README and use it for the module level documentation. So, there's a MD to ReST auto conversions that needs to happen. Did you consider how it impacts that? |
Author
|
Hi, I'm glad you like it! :) I find icons/emojis useful to identify sections quicker, but it's subjective. Unfortunately, I did not know about MD to ReST auto conversions. |
Member
|
Line 22 in 2bcda77 |
This file contains hidden or 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.
Hi,
I had an issue with multiprocessing that this library instantly solved.
To thank you for your work, I've refactored the README to make it more appealing and readable.
I followed what I think are best practices for drawing up readme files.
Feel free to copy/paste what you like or discard my changes entirely.
Best,
Elias