Validate mkdocs.yml config on values that we manipulate #5119
Conversation
This file contains hidden or 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
humitos
force-pushed
the
humitos/validate-mkdocs-configs
branch
2 times, most recently
from
cdaa4d7 to
7f530d8
Compare
ericholscher
approved these changes
Jan 16, 2019
|
|
||
| INVALID_DOCS_DIR_CONFIG = ugettext_noop( | ||
| 'The "docs_dir" config from your MkDocs YAML config file has to be a ' | ||
| 'string with relative or absolute path.', |
There was a problem hiding this comment.
It feels weird to quote this, we should just say it.
There was a problem hiding this comment.
Nevermind, I read this wrong.
Make sure that the values we will manipulate from the mkdocs.yml file the correct type we need them to be. If we found a problem with them, we report a proper message to user to debug it by themselves.
humitos
force-pushed
the
humitos/validate-mkdocs-configs
branch
from
7f530d8 to
2df203e
Compare
The test that failed helped me to find a bug in my code ;) Also, I added tests for the case of invalid configs also. I'll merge once test pass on Travis. |
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.
Make sure that the values we will manipulate from the mkdocs.yml filethe co rrect type we need them to be. If we found a problem with them, we report a proper message to user to debug it by themselves.