MDLSITE-7037: Update index.md with new line length limit. - #1656
Open
scyrma wants to merge 1 commit into
Open
Conversation
Updating documentation, following coding style change relating to line length done in https://moodle.atlassian.net/browse/MDLSITE-7037
✅ Deploy Preview for moodledevdocs ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Moodle developer coding style documentation to reflect the newer guidance on maximum line length.
Changes:
- Replaces the previous 132/180-character guidance with an 80-character preferred limit and a 120-character “if needed” target for readability.
| The key issue is readability. | ||
|
|
||
| Aim for 132 characters if it is convenient, it is not recommended to use more than 180 characters. | ||
| While there is no hard limit on line length, lines should not be longer than 80 characters, and lines longer than that should be split into multiple subsequent lines of no more than 80 characters each. If this is inconvenient, or impacts readability, aim to keep lines under 120 characters as much as possible. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updating documentation, following coding style change relating to line length done in https://moodle.atlassian.net/browse/MDLSITE-7037