MetOffice / MetOffice/ANTS

Adopt a 80 character line length for rst files

Open
#111 0 comments 0 reactions 0 assignees View on GitHub
📚 documentation 🛠️ infrastructure
Dominant language
Python
Stars
7
Forks
10
Avg merge
1d 19h
Merged PRs (30d)
5

Description

# 📚 Documentation Request

We should aim for a maximum line length of 80 characters in our documentation rst files. This makes it easier to read in a text editor, easier to make small documentation fixes/tweaks, and does not affect the built html documentation.

Success Criteria:

- Update working practices
- Fix existing docs
- Investigate if we can enforce this in testing.

Contributor guide

Open the contributing guide

Research direction

Start by locating the existing documentation .rst files and the project's testing configuration. Update working practices, reformat existing documentation to a maximum of 80 characters per line, and investigate whether a test can enforce the limit; done means these three success criteria are addressed.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.