search

backdrop / backdrop-issues

Issue tracker for Backdrop core.
144 stars 39 forks source link

[DX] Fix coding standards around docblocks in `settings.php` #6612

Open klonos opened 2 months ago

klonos commented 2 months ago

There's some inconsistencies and things like missing periods/punctuation. We should fix that according to https://docs.backdropcms.org/doc-standards#general

Specifically these rules:

  • All summaries (first lines of docblocks) must be under 80 characters, start with a capital letter, and end with a period (.). ...
  • Sentences should be separated by single spaces.
  • Comments and variable names should be in English, and use US English spelling (e.g., "color" not "colour").
  • ...
quicksketch commented 2 weeks ago

Overall looks good but there are two strange situations created by separating the first sentence in each docblock. I posted some suggestions to https://github.com/backdrop/backdrop/pull/4794#pullrequestreview-2258300190.

quicksketch commented 1 week ago

@avpaderno Also left a round of review on the PR.