-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Spell check configuration, fixed formatting errors (#28)
* Spelling and formatting fixes * spellcheck configuration with updated rules to ignore common Kubernetes terms * Update spellcheck config filename
- Loading branch information
1 parent
3c9abb8
commit f76fdb0
Showing
4 changed files
with
262 additions
and
6 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,206 @@ | ||
| # BSD 3-Clause License | ||
| # | ||
| # Copyright (c) 2017-2022, Pytorch contributors | ||
| # All rights reserved. | ||
| # Modifications Copyright (c) 2023, Advanced Micro Devices, Inc. | ||
| # All rights reserved. | ||
| # | ||
| # Redistribution and use in source and binary forms, with or without | ||
| # modification, are permitted provided that the following conditions are met: | ||
| # | ||
| # * Redistributions of source code must retain the above copyright notice, this | ||
| # list of conditions and the following disclaimer. | ||
| # | ||
| # * Redistributions in binary form must reproduce the above copyright notice, | ||
| # this list of conditions and the following disclaimer in the documentation | ||
| # and/or other materials provided with the distribution. | ||
| # | ||
| # * Neither the name of the copyright holder nor the names of its | ||
| # contributors may be used to endorse or promote products derived from | ||
| # this software without specific prior written permission. | ||
|
|
||
| # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
| # DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE | ||
| # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
| # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | ||
| # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | ||
| # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | ||
| # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
|
|
||
| matrix: | ||
| - name: Markdown | ||
| sources: | ||
| - ['docs/**/*.md', '!docs/doxygen/mainpage.md'] | ||
| - ['tools/autotag/templates/**/*.md', '!tools/autotag/templates/**/5*.md', '!tools/autotag/templates/**/6.0*.md', '!tools/autotag/templates/**/6.1*.md'] | ||
| expect_match: false | ||
| aspell: | ||
| lang: en | ||
| dictionary: | ||
| wordlists: | ||
| - .wordlist.txt | ||
| pipeline: | ||
| - pyspelling.filters.context: | ||
| context_visible_first: true | ||
| delimiters: | ||
| # Manual disabling via: #spellcheck-disable | ||
| - open : '^ *<!-- *spellcheck-disable *-->$' | ||
| content: '[\s\S]*?' | ||
| close: '^ *<!-- *spellcheck-enable *-->$' | ||
| # Ignore URLs in [text](URL) | ||
| - open : '\[[^]]*?]\(' | ||
| content: '[^)]*?' | ||
| close: '\)' | ||
| # Ignore out-of-line URL references in [text][reference-name] | ||
| - open : '\[[^\]]*?\]\[' | ||
| content: '[^\]]*?' | ||
| close: '\]' | ||
| # Ignore out-of-line URL definitions | ||
| - open : '^ {0,3}\[[^\]]*?\]:\s*\S+' | ||
| close: '$' | ||
| # Ignore URLs in <URL> | ||
| - open : '\<' | ||
| content: '[^]]*?' | ||
| close: '\>' | ||
| # Ignore text in backtick code blocks. | ||
| - open : '(?s)^(?P<open> *`{3,})[^\n]*$' | ||
| close: '^(?P=open)$' | ||
| # Ignore text between inline back ticks | ||
| - open : '(?P<open>`+)' | ||
| content: '[^\n]+' | ||
| close: '(?P=open)' | ||
| # Ignore block classes and extra in :::{class} extra | ||
| - open : '^ *:{3,}' | ||
| content: '[^\n]+' | ||
| close: '' | ||
| # Ignore keys in :property: key | ||
| - open : '^ *:[^\n:]*: +' | ||
| content: '[^\n]+' | ||
| close: '$' | ||
| # Ignore properties in :property: | ||
| - open : '^ *:' | ||
| close: ':' | ||
| # Ignore tag in (tag)= | ||
| - open : '(' | ||
| content: '[^\n]+' | ||
| close: ')=$' | ||
| # Ignore hyphenated technical terms like amd-smi | ||
| - open: '\b[a-zA-Z]+-[a-zA-Z-]+\b' | ||
| close: '' | ||
| # Ignore command patterns like kubectl apply -f | ||
| - open: '\b[a-zA-Z-]+\s+[a-zA-Z-]+\s+-[a-zA-Z]\b' | ||
| close: '' | ||
| # Ignore CLI flags and their values | ||
| - open: '--[a-zA-Z-]+=?' | ||
| content: '[^\s]*' | ||
| close: '\s' | ||
| # Ignore file extensions | ||
| - open: '\.[a-zA-Z0-9]+\b' | ||
| content: '' | ||
| close: '' | ||
| # Ignore k8s resource names | ||
| - open: '\b[a-z-]+\.(yaml|json|conf)\b' | ||
| close: '' | ||
| # Configuration keys and values | ||
| - open: '^\s*[a-zA-Z]+[a-zA-Z0-9]*:' | ||
| content: '.*' | ||
| close: '$' | ||
| - open: '[a-zA-Z]+[a-zA-Z0-9]*=[^\s]*' | ||
| close: '' | ||
| # Handle all variations of config keys (camelCase, lowercase, etc) | ||
| - open: '\b[a-z]+[a-zA-Z0-9]*(?:[A-Z][a-z0-9]+)*\b' | ||
| close: '' | ||
| - pyspelling.filters.url: | ||
| - name: reST | ||
| sources: | ||
| - 'docs/**/*.rst' | ||
| expect_match: false | ||
| aspell: | ||
| lang: en | ||
| dictionary: | ||
| wordlists: | ||
| - .wordlist.txt | ||
| pipeline: | ||
| - pyspelling.filters.text: | ||
| - pyspelling.filters.context: | ||
| context_visible_first: true | ||
| delimiters: | ||
| # Ignore possessive endings | ||
| - open: '(?<=\w)''s(?!\w)' | ||
| close: '\b' | ||
| # Ignore text between inline back ticks | ||
| - open: '(div style|iframe).*' | ||
| close: '\n' | ||
| - open: '(- )?(?P<open>`+)' | ||
| close: '(?P=open)' | ||
| # Ignore reStructuredText roles | ||
| - open: ':(?:(class|file|func|math|ref|octicon|meth|obj)):`' | ||
| content: '[^`]*' | ||
| close: '`' | ||
| - open: ':width:' | ||
| close: '$' | ||
| # Exclude raw directive | ||
| - open: '\.\. (raw|grid-item-card|galleryitem|includenodoc)::.*$\n*' | ||
| close: '\n' | ||
| # Ignore reStructuredText literals | ||
| - open: '::$' | ||
| close: '(?P<literal>(?:((?P<indent>[ ]+).*$)|(\n))+)' | ||
| # Ignore reStructuredText hyperlinks | ||
| - open: '\s' | ||
| content: '\w*' | ||
| close: '_' | ||
| # Ignore reStructuredText header --- | ||
| - open: '^' | ||
| content: '--*' | ||
| close: '$' | ||
| # Ignore reStructuredText header ''' | ||
| - open: '^' | ||
| content: '''''*' | ||
| close: '$' | ||
| # Ignore reStructuredText block directives | ||
| - open: '\.\. (code-block|math|csv-table)::.*$\n*' | ||
| content: '(?P<first>(^(?P<indent>[ ]+).*$\n))(?P<other>(^([ \t]+.*|[ \t]*)$\n)*)' | ||
| close: '(^(?![ \t]+.*$))' | ||
| - open: '\.\. (raw)::.*$\n*' | ||
| close: '^\s*$' | ||
| # Ignore reStructuredText substitution definitions | ||
| - open: '^\.\. \|[^|]+\|' | ||
| close: '$' | ||
| # Ignore reStructuredText substitutions | ||
| - open: '\|' | ||
| content: '[^|]*' | ||
| close: '\|_?' | ||
| # Ignore reStructuredText toctree | ||
| - open: '\.\.\s+toctree::' | ||
| close: '(?P<toctree>(?:((?P<indent>[ ]+).*$)|(\n))+)' | ||
| # Ignore directives | ||
| - open: '\.\.\s+(figure|image|include|only|tabularcolumns|datatemplate:nodata)::' | ||
| close: '$' | ||
| # Ignore reStructuredText reference | ||
| - open: '^.{2}[ ]+_' | ||
| close: '$' | ||
| # Ignore doxygen directives | ||
| - open: '\.\. (autodoxygenindex|doxygenfunction|doxygenstruct|doxygenclass|doxygennamespace|doxygenconcept|doxygenenum|doxygenenumvalue|doxygentypedef|doxygenunion|doxygendefine|doxygenvariable|doxygenfile|doxygengroup|autodoxygenfile|doxygenpage)::.*$\n*' | ||
| content: '(?P<first>(^(?P<indent>[ ]+).*$\n))(?P<other>(^([ \t]+.*|[ \t]*)$\n)*)' | ||
| close: '(^(?![ \t]+.*$))' | ||
| # Ignore doxygen one line directives | ||
| - open: '\.\. (autodoxygenindex|doxygenfunction|doxygenstruct|doxygenclass|doxygennamespace|doxygenconcept|doxygenenum|doxygenenumvalue|doxygentypedef|doxygenunion|doxygendefine|doxygenvariable|doxygenfile|doxygengroup|autodoxygenfile|doxygenpage)::' | ||
| content: '[ \S]*' | ||
| close: '\n' | ||
| # Manual disabling via: #spellcheck-disable | ||
| - open : '^.. <!-- spellcheck-disable -->$' | ||
| content: '[\s\S]*?' | ||
| close: '^.. <!-- spellcheck-enable -->$' | ||
| # Ignore hyphenated technical terms like amd-smi | ||
| - open: '\b[a-zA-Z]+-[a-zA-Z-]+\b' | ||
| close: '' | ||
| # Ignore command patterns like kubectl apply -f | ||
| - open: '\b[a-zA-Z-]+\s+[a-zA-Z-]+\s+-[a-zA-Z]\b' | ||
| close: '' | ||
| # Ignore CLI flags and their values | ||
| - open: '--[a-zA-Z-]+=?' | ||
| content: '[^\s]*' | ||
| close: '\s' | ||
| - pyspelling.filters.url: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| CLI | ||
| CNI | ||
| DKMS | ||
| DNS | ||
| DockerHub | ||
| GPUs | ||
| HTTPS | ||
| KMM | ||
| MOK | ||
| NFD | ||
| OLM | ||
| PCI | ||
| RBAC | ||
| ROCm | ||
| TLS | ||
| YAML | ||
| allocatable | ||
| bool | ||
| calico | ||
| clusterIP | ||
| config | ||
| configmap | ||
| cryptographic | ||
| daemonset | ||
| DeviceConfig | ||
| Dockerfile | ||
| flannel | ||
| hostname | ||
| hostnames | ||
| json | ||
| kaniko | ||
| Kubernetes | ||
| kubeconfig | ||
| labeller | ||
| lifecycle | ||
| modprobe | ||
| namespace | ||
| NodePort | ||
| NotReady | ||
| plugin | ||
| PreFlight | ||
| prometheus | ||
| quay | ||
| rocminfo | ||
| runtime | ||
| schedulable | ||
| systemd | ||
| ubuntu | ||
| unschedulable | ||
| validation | ||
| verison | ||
| webhook | ||
| CRD | ||
| uninstallation |
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
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