Skip to content

Commit

Permalink
📝 Updated documentation with style (#15)
Browse files Browse the repository at this point in the history
  • Loading branch information
dpi authored Jan 12, 2023
1 parent a82c1c6 commit eedef4a
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
[![GitHub branch checks state](https://img.shields.io/github/checks-status/previousnext/coding-standard/master)][ci]
[![License](http://poser.pugx.org/previousnext/coding-standard/license)](https://packagist.org/packages/previousnext/coding-standard)

This is a PHP Codesniffer standard enhancing the [Drupal Coder][drupal-coder]
This is a PHP Codesniffer standard enhancing the [Drupal Coder][drupal-coder]
project. It is designed to be utilised on full Drupal site projects, rather than
core or contrib, or projects outside of Drupal.

The standard improves upon the Drupal standard, while maintaining the general
The standard improves upon the Drupal standard, while maintaining the general
style of Drupal.

Rules are loosened where static analysis tools such as PHPStan are better at
Expand All @@ -34,7 +34,7 @@ MIT

# Transitioning

Consider using the [Baseliner][php-codesniffer-baseline] project when
Consider using the [Baseliner][php-codesniffer-baseline] project when
transitioning. A quick `phpcbf` beforehand will eliminate most or all problems
before they are added to a baseline.

Expand Down Expand Up @@ -112,7 +112,7 @@ function foo(array $data): int {
To:

Remove useless documentation for the function/method itself. Human code review
must ensure the function/method/variable/param, etc, are self describing.
must ensure the function/method/variable/param, etc, are self describing.

```php
/**
Expand All @@ -128,6 +128,17 @@ function doesAThing(array $data): int {

## Added Sniffs

#### PSR2.Methods.FunctionClosingBrace.SpacingBeforeClose
#### SlevomatCodingStandard.Classes.ClassStructure
#### SlevomatCodingStandard.Functions.RequireTrailingCommaInCall
#### SlevomatCodingStandard.Functions.StaticClosure
#### SlevomatCodingStandard.Functions.UnusedInheritedVariablePassedToClosure
#### SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses
#### SlevomatCodingStandard.TypeHints.DeclareStrictTypes
#### SlevomatCodingStandard.TypeHints.ReturnTypeHint
#### SlevomatCodingStandard.TypeHints.ReturnTypeHintSpacing
#### Squiz.WhiteSpace.FunctionOpeningBraceSpace.SpacingAfter

## Removed/Loosened Inherited Sniffs

#### Drupal.Arrays.Array.LongLineDeclaration
Expand Down

0 comments on commit eedef4a

Please sign in to comment.