Code block width should max out at 79c?

Open
  • Is something wrong?
#1,186 0 comments 1 reaction 0 assignees View on GitHub

Maintainers usually reply within 2 days

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
57/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Read the pre-commit configuration changed in #1143 and compare it with the main repository’s setting and the example fix in PR #1185. Determine whether the code formatter should be configured for an 80-character line length; done means the configuration reflects the agreed width and the resulting formatting is consistent.

Written by the indexing model from the issue text.

Description

@TimMonko @brisvag I missed that the config in #1143 doesn't fit code to 79c as we do in the main repo, but instead uses black's default 89c. 🤢 😂 See this pre-commit fix on my recent PR.

In addition to my own preference for actually following PEP-8, I think in docs it's even more critical to fit code in a narrow space, as I often find myself side-scrolling on online code when on mobile or when having a browser window side by side with my code.

Should we update the config to fit in 80c?

Dominant language
Makefile
Stars
13
Forks
71
Avg merge
3d 8h
Merged PRs (30d)
31

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from napari/docs

All issues in napari/docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.