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.

Sign up for GitHub

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

Jump to bottom

Improving the formatting of the README, particularly the giant code block under SYNOPSIS #219

Closed
joshstephenson opened this issue Sep 7, 2024 · 1 comment · Fixed by #220
Closed

Improving the formatting of the README, particularly the giant code block under SYNOPSIS #219

joshstephenson opened this issue Sep 7, 2024 · 1 comment · Fixed by #220
Assignees
@joshstephenson

Comments

@joshstephenson
Copy link
Contributor

The giant code block under SYNOPSIS could be improved by breaking it into separate code blocks with interwoven markdown more like the FORMING PLURALS AND SINGULARS section. I also believe the formatting of the description could be improved.

Please let me know if you would be interested in this and I will submit a PR.
@jaraco
Copy link
Owner

jaraco commented Sep 7, 2024

Sounds good to me. Thanks.

@joshstephenson joshstephenson mentioned this issue Sep 9, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@joshstephenson joshstephenson

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Formatting Improvements to Synopsis in README joshstephenson/inflect
2 participants
@joshstephenson @jaraco