Add Vale config #3585
Merged
Add Vale config #3585
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
andreyaksenov
force-pushed
the
vale-config
branch
from
6f48df0
to
8749037
Compare
p7nov
approved these changes
Jul 21, 2023
styles/Tarantool/Latin.yml
Outdated
There was a problem hiding this comment.
Already added in Foreign.yml
There was a problem hiding this comment.
Moved Terms.yml words to WordList.yml.
styles/Vocab/Tarantool/accept.txt
Outdated
| sharded | ||
| nullable | ||
| coroutines | ||
| multikey |
There was a problem hiding this comment.
Suggested change
| multikey | |
| multikey | |
| datetime | |
| varbinary |
styles/Tarantool/WordList.yml
Outdated
| Android device: Android-powered device | ||
| android: Android | ||
| API explorer: APIs Explorer | ||
| application: app |
There was a problem hiding this comment.
Not sure this is valid for our case.
There was a problem hiding this comment.
agree, forgot to remove
styles/Tarantool/ComplexWords.yml
Outdated
| methodology: method | ||
| modify: change | ||
| monitor: check|watch | ||
| multiple: many |
There was a problem hiding this comment.
'multiple' seems fine to me.
styles/Tarantool/ComplexWords.yml
Outdated
| consequently: so | ||
| consolidate: merge | ||
| constitutes: forms | ||
| contains: has |
There was a problem hiding this comment.
'contains' seems fine to me.
styles/Tarantool/WordList.yml
Outdated
| cellular network: mobile network | ||
| chapter: documents|pages|sections | ||
| check box: checkbox | ||
| check: select |
| level: warning | ||
| ignorecase: true | ||
| tokens: | ||
| - currently |
There was a problem hiding this comment.
Suggested change
| - currently | |
| - currently | |
| - previously | |
| - now | |
| - today | |
| - in(?: the|) future |
andreyaksenov
force-pushed
the
vale-config
branch
4 times, most recently
from
aa17361
to
27b0e74
Compare
andreyaksenov
force-pushed
the
vale-config
branch
from
27b0e74
to
76196b3
Compare
xuniq
approved these changes
Jul 21, 2023
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.
Added the Vale configuration to the documentation. This configuration includes two predefined packages that implement Microsoft and Google style guides:
Moreover, this PR includes a custom
Tarantoolstyle, which includes several rules from the GitLab config.Apart from three styles, the
styles/Vocab/Tarantool/accept.txtfile contains valid Tarantool-specific terms.To show Vale warnings in the PyCharm editor, follow the steps below (macOS):
brew install vale.brew install sphinx-doc.Preferences | Editor | Natural Languages | Grazie Professionalpage, turn on theEnable Vale annotationsoption.vale synccommand.PyCharm should now use the Vale config automatically (
.vale.ini) and show warnings right in the editor:Please add your suggestions regarding customizing Microsoft/Google styles or adding Tarantool-specific rules and terms.