Document fix: Add note to use .yaml for file extension #1298
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The document needs to explicitly note that file extension should be `yaml`, and `.yml` can't be used. I ran in a error when trying to use `.yml`, and took some time to solve. Related issues: facebookresearch#398 facebookresearch#1050
facebook-github-bot
added
the
CLA Signed
|
Thanks for your suggestion. In addition, the intro page is not meant as a comprehensive guide. More of a minimal overview of some of the core features. Closing this because I think the information in the basic tutorial is sufficient. Feel free to continue the discussion here. |
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
I ran into
MissingConfigExceptionerror when trying to use.ymlfor config, and took some time to discover that file extension is required to be.yaml.This seems to be not written anywhere in the documentation explicitly.
So I want to add note to the document (for other beginners like me).
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
Related Issues and PRs
Previous discussions to support
.ymlor not (concluded not to support for now).#398 #1050