[docs] Updating coding style per MDLSITE-7597 #1391
Conversation
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
This change updates the coding style to remove legacy line wrapping rules, and other parts which are explicitly defined by PSR-12.
✅ Deploy Preview for moodledevdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Moodle coding style guide by removing legacy line-wrapping and indentation rules that are now covered by PSR-12, and streamlining naming conventions.
- Removes custom indentation and wrapping examples in favor of PSR-12 defaults
- Simplifies function/method naming rules and scopes Frankenstyle prefix to legacy globals
- Adds clarity notes around “de-facto Moodle standards” and ongoing code modernization
Comments suppressed due to low confidence (2)
general/development/policies/codingstyle/index.md:70
- [nitpick] After removing the dedicated 'Indentation' section, consider adding a brief reference to PSR-12's default indentation rules or linking to the relevant PSR-12 documentation so readers know where to find them.
SQL queries use special indentation, see [SQL coding style](./sql.md).
general/development/policies/codingstyle/index.md:265
- [nitpick] To avoid ambiguity, it may help to include a concrete example of a legacy function name using the Frankenstyle prefix to illustrate the expected format.
Method and function names should be simple English lowercase words. Words should be separated by underscores.
|
Change to the coding style: moodlehq/moodle-cs#201 |
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.
This change updates the coding style to remove legacy line wrapping rules, and other parts which are explicitly defined by PSR-12.