-
Notifications
You must be signed in to change notification settings - Fork 959
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
Improved edits to the README.md
file
#1479
Conversation
Shows all the content headings within the README file and links it to the location accordingly
As displayed in Line 99, the appropriate format has been mentioned for soundfile and audioread
Makes it easier for the user to go back up to the file when they are at the very bottom of the file
And a minor change to the heading by adding '#' to the heading Finally, center-aligning the logo, heading
Hey @bmcfee ! Sure, that can be possible As center-aligning the logo, header make it easier for them to read If you could maybe share a screenshot within this thread of how it looks like, it'd help get a better idea perhaps. If it doesn't go well, I can change those HTML elements to a (similar) Markdown state. Regards, |
Please disregard my review. I hadn't considered the importance of handling PyPI README |
The short answer is that I don't know, and I'd prefer to not deploy a test package just to find out. According to the official docs, github-flavored markdown is supported as the default markdown. While that does techinically allow for inlined HTML, I'd still prefer to avoid it. |
Hi @bmcfee , I have done the necessary changes as you had asked in the next commit following your comment. Let me know if there is anything else that is required. Regards, P.S. I do suggest having a look if inline HTML does work in the documentation as it can definitely widen the possibilities of how you can show your documentation out there |
This looks fine to me. Thanks again. |
Reference Issue
None
What does this implement/fix? Explain your changes.
This implementation improves the overall layout of the README file
Any other comments?
Feel free to add any more changes to these commits as you please.
Regards,
@cr2007