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

Update README.md #144

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #144

wants to merge 1 commit into from

Conversation

AmenRa
Copy link

@AmenRa AmenRa commented May 19, 2023

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

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
@mmckerns
Copy link
Member

mmckerns commented Jun 3, 2023

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?

@AmenRa
Copy link
Author

AmenRa commented Jun 3, 2023

Hi, I'm glad you like it! :)

I find icons/emojis useful to identify sections quicker, but it's subjective.
I can make another pr without them, or you can remove them afterward.

Unfortunately, I did not know about MD to ReST auto conversions.

@mmckerns
Copy link
Member

mmckerns commented Jun 4, 2023

def get_readme_as_rst(filepath):

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.

2 participants