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

Quick reformat / word-wrap reflow of README and CONTRIBUTING docs to fit in a TTL window #720

Merged
merged 1 commit into from
Dec 16, 2024

Conversation

jonsedar
Copy link
Contributor

@jonsedar jonsedar commented Nov 6, 2024

The README.rst and CONTRIBUTING.md docs are currently very wide, typically >120 chars, as wide as 280 chars. This makes reading in terminal difficult.

This tiny PR reformats them to a more standard 80 chars wide, and where long hyperlinks dont fit it seems reasonable to allow up to approx 120 chars


📚 Documentation preview 📚: https://pymc-examples--720.org.readthedocs.build/en/720/

+ reformat CONTRIBUTING.md
Copy link
Member

@fonnesbeck fonnesbeck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@fonnesbeck fonnesbeck merged commit 7575eee into pymc-devs:main Dec 16, 2024
3 checks passed
@jonsedar
Copy link
Contributor Author

Thanks @fonnesbeck!

@jonsedar jonsedar deleted the format-readme branch December 17, 2024 05:29
fonnesbeck pushed a commit to fonnesbeck/pymc-examples that referenced this pull request Dec 20, 2024
+ reformat CONTRIBUTING.md
fonnesbeck pushed a commit to fonnesbeck/pymc-examples that referenced this pull request Dec 20, 2024
+ reformat CONTRIBUTING.md
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