Skip to content

YML files are not YAML files #5533

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

Closed
AvdN opened this issue Jul 1, 2019 · 2 comments · Fixed by #5540
Closed

YML files are not YAML files #5533

AvdN opened this issue Jul 1, 2019 · 2 comments · Fixed by #5540
Labels
good first issue easy issue that is friendly to new contributor type: docs documentation improvement, missing or needing clarification

Comments

@AvdN
Copy link
Contributor

AvdN commented Jul 1, 2019

https://docs.pytest.org/en/latest/example/nonpython.html has a description of using YAML files.

However there is repeated reference to .yml files. YML (https://fdik.org/yml/) is a different format that is almost as old as YAML.

The recommended file extension for YAML files has been .yaml since 2006 (https://web.archive.org/web/20060924190202/http://yaml.org/faq.html)

Please use the appropriate extension for YAML files and change the option --run-yml to --run-yaml, because pytest is not using YML files at all.

@asottile
Copy link
Member

asottile commented Jul 1, 2019

this seems pedantic at best 🤷‍♂ -- I can't find any reference to the .yml file extension referring to YML files, however I can find many many references to them containing YAML

In fact on github there are 39 million results for filename:*.yml yet only 6 million results for filename:*.yaml

@nicoddemus
Copy link
Member

nicoddemus commented Jul 1, 2019

Yeah TBH I never thought there was a difference... for example conda uses meta.yaml for build recipes, and environment.yml for environment files, and both are in the YAML format.

I always thought both .yml and .yaml were valid extensions for YAML files.

Please use the appropriate extension for YAML files and change the option --run-yml to --run-yaml, because pytest is not using YML files at all.

Having said that I would be happy to merge a PR updating the docs to use only .yaml. 👍

@nicoddemus nicoddemus added good first issue easy issue that is friendly to new contributor type: docs documentation improvement, missing or needing clarification labels Jul 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue easy issue that is friendly to new contributor type: docs documentation improvement, missing or needing clarification
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants