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

Docs: Code block line length #3211

Open
JacobCoffee opened this issue Mar 16, 2024 · 0 comments
Open

Docs: Code block line length #3211

JacobCoffee opened this issue Mar 16, 2024 · 0 comments
Labels
Documentation 📚 This is related to documentation Good First Issue This is good for newcomers to take on Help Wanted 🆘 This is good for people to work on

Comments

@JacobCoffee
Copy link
Member

JacobCoffee commented Mar 16, 2024

Summary

For documentation, and only documentation, if you have an overly long code block it enters scrollable window.

We should set blacken-docs configuration (and eventually ruff when astral-sh/ruff#8237 happens) to line lengths somewhere on the lower end (maybe 80?); this goes together with manually ensuring .. code-block:: directives are not overly long


Note

While we are open for sponsoring on GitHub Sponsors and
OpenCollective, we also utilize Polar.sh to engage in pledge-based sponsorship.

Check out all issues funded or available for funding on our Polar.sh dashboard

  • If you would like to see an issue prioritized, make a pledge towards it!
  • We receive the pledge once the issue is completed & verified
  • This, along with engagement in the community, helps us know which features are a priority to our users.
Fund with Polar
@JacobCoffee JacobCoffee added Documentation 📚 This is related to documentation Help Wanted 🆘 This is good for people to work on Good First Issue This is good for newcomers to take on labels Mar 16, 2024
JacobCoffee added a commit that referenced this issue Mar 16, 2024
JacobCoffee added a commit that referenced this issue Mar 17, 2024
JacobCoffee added a commit that referenced this issue Mar 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation 📚 This is related to documentation Good First Issue This is good for newcomers to take on Help Wanted 🆘 This is good for people to work on
Projects
Status: Backlog
Development

No branches or pull requests

1 participant