search

phpro / grumphp

A PHP code-quality tool
MIT License
4.14k stars 430 forks source link

Consistently use yml instead of yaml extension in documentation #824

Closed ghost closed 3 years ago

ghost commented 3 years ago
Q A
Branch master
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no
Documented? no
Fixed tickets

Even though I can see that grumphp allows for both yml and yaml configuration files like it is supposed to:

https://github.com/phpro/grumphp/blob/0e6287a3ae70a8730d11a239449e991b3fc78f99/src/Locator/GuessedPathsLocator.php#L109-L112

I think semantically it's best to stay consistent through out the documentation to only reference one of the allowed extensions. A quick search showed that yml was the prefered extension:

This pull request changes the extension in the documentation only. No code is touched. Maybe we could document that the GuessedPathsLocator allows for both yml and yaml extension on the grumphp configuration files. I just don't really know where to put that.

veewee commented 3 years ago

Thanks! Makes sense to make it consistent. There isn't really a preferred extension at the moment. So it's ok to stick with .yml, since it is the first in the list and will be autocreated by GrumPHP.