Clean up the readme a bit #15
Closed
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
Comment on lines
-49
to
+53
| this program, as well as submitting changes. | ||
| When scanning a file, unicop will look for a `unicop.toml` config file in the same directory as the file being scanned. If one does not exist it check in the parent directory. It keeps looking up the directory tree until finding a config file or reaching the filesystem root. If no config file is found, the unicop defaults are used. | ||
|
|
||
| ## Todo | ||
| ### Defaults | ||
|
|
||
| Things left to implement to make this usable | ||
| The default configuration is to allow all unicode code points except bidirectional (bidi) characters in | ||
| comments and in string literals. In all other places only ASCII characters are allowed. |
There was a problem hiding this comment.
So we don't forget: we discussed that this doesn't really explain the relation between the user config and the defaults. Perhaps it could be rewritten by explaining the defaults first and then how unicop.toml can be used to extend the defaults.
|
This is no longer relevant. |
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.
No description provided.