Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consistently use yml instead of yaml extension in documentation #824

Merged
merged 1 commit into from Oct 2, 2020
Merged

Consistently use yml instead of yaml extension in documentation #824

merged 1 commit into from Oct 2, 2020

Conversation

ghost
Copy link

@ghost ghost commented Oct 1, 2020

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:

'grumphp.yml',
'grumphp.yaml',
'grumphp.yml.dist',
'grumphp.yaml.dist',

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:

  • 11 results in 6 files for grumphp.yaml
  • 148 results in 71 files for grumphp.yml

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 veewee added this to the 1.1.0 milestone Oct 2, 2020
@veewee veewee merged commit 3e0edc0 into phpro:master Oct 2, 2020
@veewee
Copy link
Contributor

veewee commented Oct 2, 2020

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant