Vale precommit #1861
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| StylesPath = .vale/styles | ||
| MinAlertLevel = suggestion | ||
|
|
||
| Vocab = NVIDIA | ||
|
|
||
| [*.rst] | ||
| BasedOnStyles = Vale, NVIDIA | ||
|
|
||
| # Skip inline Sphinx roles (:class:`...`, :const:`...`, etc.), Sphinx | ||
| # directive blocks (.. automodule:: ...), which rst2html leaves as text, | ||
| # and dotted code paths in prose: multi-segment (physicsnemo.metrics.mse) | ||
| # and lowercase two-segment (physicsnemo.mesh; first segment 2+ chars so | ||
| # "e.g."/"i.e." stay visible to NVIDIA.LatinAbbreviations). | ||
| TokenIgnores = (:[a-zA-Z:]+:`[^`]+`_?), (\b[A-Za-z_][\w]*\.[A-Za-z_][\w]*(?:\.[A-Za-z_][\w]*)+\b), (\b[a-z_][\w]+\.[a-z_][\w]*\b) | ||
| BlockIgnores = (?m)^\.\. [a-zA-Z:]+::[^\n]*(?:\n[ \t]+[^\n]*)* |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,273 @@ | ||
| # Adapted from the MIT-licensed Microsoft style for Vale | ||
| # (https://github.com/errata-ai/Microsoft). | ||
| extends: existence | ||
| message: "Remove '%s' if it's not important to the meaning of the statement." | ||
| ignorecase: true | ||
| level: suggestion | ||
| action: | ||
| name: remove | ||
| tokens: | ||
| - abnormally | ||
| - absentmindedly | ||
| - accidentally | ||
| - adventurously | ||
| - anxiously | ||
| - arrogantly | ||
| - awkwardly | ||
| - bashfully | ||
| - beautifully | ||
| - bitterly | ||
| - bleakly | ||
| - blindly | ||
| - blissfully | ||
| - boastfully | ||
| - boldly | ||
| - bravely | ||
| - briefly | ||
| - brightly | ||
| - briskly | ||
| - broadly | ||
| - busily | ||
| - calmly | ||
| - carefully | ||
| - carelessly | ||
| - cautiously | ||
| - cheerfully | ||
| - cleverly | ||
| - closely | ||
| - coaxingly | ||
| - colorfully | ||
| - continually | ||
| - coolly | ||
| - courageously | ||
| - crossly | ||
| - cruelly | ||
| - curiously | ||
| - daintily | ||
| - dearly | ||
| - deceivingly | ||
| - deeply | ||
|
Collaborator
There was a problem hiding this comment. "deeply-nested dictionary" seems fair game |
||
| - defiantly | ||
| - deliberately | ||
|
Collaborator
There was a problem hiding this comment. This one feels like it has a place in comments/docstrings? "This is deliberately left as X, for reason Y" conveys intent |
||
| - delightfully | ||
| - diligently | ||
| - dimly | ||
| - doubtfully | ||
| - dreamily | ||
| - easily | ||
| - effectively | ||
|
Comment on lines
+57
to
+58
Collaborator
There was a problem hiding this comment. I am imagining these two are going to show up pretty often in our current docs :)
Collaborator
There was a problem hiding this comment. effective would be ok.....effectively doesn't show up that often in the tech docs I have edited. And i am trying to think back to all those HP, IBM, Cisco drafts of things. Usually, the point of the sentence has to do with how things are effective, so al we would have to do is be specific. i do love to use elegantly in how i personally describe how things work, but again, an odd word to run into outside of the marketing content. |
||
| - elegantly | ||
| - energetically | ||
| - enormously | ||
| - enthusiastically | ||
| - excitedly | ||
| - extremely | ||
| - fairly | ||
| - faithfully | ||
| - famously | ||
| - ferociously | ||
| - fervently | ||
| - fiercely | ||
| - fondly | ||
| - foolishly | ||
| - fortunately | ||
| - frankly | ||
| - frantically | ||
| - freely | ||
| - frenetically | ||
| - frightfully | ||
| - furiously | ||
| - generally | ||
| - generously | ||
| - gently | ||
| - gladly | ||
| - gleefully | ||
| - gracefully | ||
|
Collaborator
There was a problem hiding this comment. Graceful(ly) is often used in a technical sense to describe fallbacks |
||
| - gratefully | ||
| - greatly | ||
| - greedily | ||
| - happily | ||
| - hastily | ||
| - healthily | ||
| - heavily | ||
|
Collaborator
There was a problem hiding this comment. "heavily compressed"? |
||
| - helplessly | ||
| - honestly | ||
| - hopelessly | ||
| - hungrily | ||
| - innocently | ||
| - inquisitively | ||
| - intensely | ||
| - intently | ||
| - interestingly | ||
| - inwardly | ||
| - irritably | ||
| - jaggedly | ||
| - jealously | ||
| - jovially | ||
| - joyfully | ||
| - joyously | ||
| - jubilantly | ||
| - judgmentally | ||
| - justly | ||
| - keenly | ||
| - kiddingly | ||
| - kindheartedly | ||
| - knavishly | ||
| - knowingly | ||
| - knowledgeably | ||
| - lazily | ||
|
Collaborator
There was a problem hiding this comment. Are we sure about this? I guess we use lazy quite a lot for dataloaders / datapipes
Collaborator
Author
There was a problem hiding this comment. I am going to switch to a knavish design for the dataloader. This will actually be really problematic if we merge this. |
||
| - lightly | ||
| - limply | ||
| - lively | ||
| - loftily | ||
| - longingly | ||
| - loosely | ||
| - loudly | ||
| - lovingly | ||
| - loyally | ||
| - madly | ||
| - majestically | ||
| - meaningfully | ||
| - mechanically | ||
| - merrily | ||
| - miserably | ||
| - mockingly | ||
| - mortally | ||
| - mysteriously | ||
| - naturally | ||
| - nearly | ||
| - neatly | ||
| - nervously | ||
| - nicely | ||
| - noisily | ||
| - obediently | ||
| - obnoxiously | ||
| - oddly | ||
| - offensively | ||
| - optimistically | ||
| - overconfidently | ||
| - painfully | ||
| - partially | ||
| - patiently | ||
| - perfectly | ||
| - playfully | ||
| - politely | ||
| - poorly | ||
| - positively | ||
| - potentially | ||
| - powerfully | ||
| - promptly | ||
| - properly | ||
| - punctually | ||
| - quaintly | ||
| - queasily | ||
| - queerly | ||
| - questionably | ||
| - quickly | ||
| - quietly | ||
| - quirkily | ||
| - quite | ||
| - quizzically | ||
| - randomly | ||
|
Collaborator
There was a problem hiding this comment. Same with this. This might be very common in math context
Collaborator
There was a problem hiding this comment. "randomly generated samples" etc. ? |
||
| - rapidly | ||
| - rarely | ||
| - readily | ||
| - really | ||
| - reassuringly | ||
| - recklessly | ||
| - regularly | ||
| - reluctantly | ||
| - repeatedly | ||
| - reproachfully | ||
| - restfully | ||
| - righteously | ||
| - rightfully | ||
| - rigidly | ||
| - roughly | ||
| - rudely | ||
| - safely | ||
| - scarcely | ||
| - scarily | ||
| - searchingly | ||
| - sedately | ||
| - seemingly | ||
| - selfishly | ||
| - separately | ||
| - seriously | ||
| - shakily | ||
| - sharply | ||
| - sheepishly | ||
| - shrilly | ||
| - shyly | ||
| - silently | ||
| - sleepily | ||
| - slowly | ||
| - smoothly | ||
| - softly | ||
| - solemnly | ||
| - solidly | ||
| - speedily | ||
| - stealthily | ||
| - sternly | ||
| - strictly | ||
| - suddenly | ||
| - supposedly | ||
| - surprisingly | ||
| - suspiciously | ||
| - sweetly | ||
| - swiftly | ||
| - sympathetically | ||
| - tenderly | ||
| - tensely | ||
| - terribly | ||
| - thankfully | ||
| - thoroughly | ||
| - thoughtfully | ||
| - tightly | ||
| - tremendously | ||
| - triumphantly | ||
| - truthfully | ||
| - ultimately | ||
| - unabashedly | ||
| - unaccountably | ||
| - unbearably | ||
| - unethically | ||
| - unexpectedly | ||
| - unfortunately | ||
| - unimpressively | ||
| - unnaturally | ||
| - unnecessarily | ||
| - urgently | ||
| - usefully | ||
| - uselessly | ||
| - utterly | ||
| - vacantly | ||
| - vaguely | ||
| - vainly | ||
| - valiantly | ||
| - vastly | ||
| - verbally | ||
| - very | ||
| - viciously | ||
| - victoriously | ||
| - violently | ||
| - vivaciously | ||
| - voluntarily | ||
| - warmly | ||
| - weakly | ||
| - wearily | ||
| - wetly | ||
| - wholly | ||
| - wildly | ||
| - willfully | ||
| - wisely | ||
| - woefully | ||
| - wonderfully | ||
| - worriedly | ||
| - yawningly | ||
| - yearningly | ||
| - yieldingly | ||
| - youthfully | ||
| - zealously | ||
| - zestfully | ||
| - zestily | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # House style: spell out "and" in prose and headings; "&" only in | ||
| # code, product names, or where space is constrained (tables). | ||
| extends: existence | ||
| message: "Use 'and' instead of '&' in prose and headings." | ||
| level: warning | ||
| nonword: true | ||
| raw: | ||
| - ' & ' |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # NVIDIA writing guidelines: brand and product names use exact casing. | ||
| extends: substitution | ||
| message: "Use '%s' instead of '%s'." | ||
| level: error | ||
| ignorecase: false | ||
| swap: | ||
| '\b(?:Nvidia|nVidia|nVIDIA)\b': NVIDIA | ||
| '\b(?:NeMoTron|NemoTron)\b': Nemotron |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # NVIDIA writing guidelines (Technical Content > Readability): | ||
| # "Use academic or formal conjunctive adverbs sparingly." | ||
| extends: existence | ||
| message: "Use the formal conjunctive adverb '%s' sparingly." | ||
| level: suggestion | ||
| ignorecase: true | ||
| tokens: | ||
| - additionally | ||
| - consequently | ||
| - furthermore | ||
| - hence | ||
| - moreover | ||
| - thus | ||
| - undoubtedly | ||
| - whilst |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # House style for formal technical documentation: expand contractions. | ||
| # (Replaces Microsoft.Contractions, which prefers the opposite.) | ||
| extends: substitution | ||
| message: "Use '%s' instead of '%s' in formal technical documentation." | ||
| level: warning | ||
| ignorecase: true | ||
| action: | ||
| name: replace | ||
| swap: | ||
| aren't: are not | ||
| can't: cannot | ||
| 'can not': cannot | ||
| couldn't: could not | ||
| didn't: did not | ||
| doesn't: does not | ||
| don't: do not | ||
| hasn't: has not | ||
| haven't: have not | ||
| isn't: is not | ||
| "it's": it is | ||
| shouldn't: should not | ||
| "that's": that is | ||
| wasn't: was not | ||
| weren't: were not | ||
| won't: will not | ||
| wouldn't: would not | ||
| "you're": you are |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # NVIDIA writing guidelines (Technical Content > File Name Extensions): | ||
| # Extensions are lowercase with a period (a .tgz file); file types are | ||
| # uppercase without a period (a TGZ file). | ||
| extends: existence | ||
| message: "Use lowercase for file name extensions ('%s'); reserve uppercase (no period) for the file type." | ||
| level: warning | ||
| ignorecase: false | ||
| raw: | ||
| - '\.(?:ZIP|TAR|TGZ|GZ|BZ2|PDF|PNG|JPE?G|GIF|SVG|YAML|YML|JSON|XML|CSV|TXT|PY|RST|MD|SH|EXE|DEB|RPM|ONNX|WHL|HTML?)\b' |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # NVIDIA writing guidelines (Technical Content > GitHub Repositories): | ||
| # "Use a forward slash and a repository name for GitHub links." | ||
| # Correct: the /NVIDIA/NeMo GitHub repo. Incorrect: the GitHub repo. | ||
| extends: existence | ||
| message: "Name the repository when referring to it, e.g. 'the /NVIDIA/PhysicsNeMo GitHub repo'." | ||
| level: suggestion | ||
| ignorecase: true | ||
| raw: | ||
| - '\bthe GitHub repo(?:sitory)?\b' |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be for md files too? The readmes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, please. Many Fern projects use MD and MDX. You all may at some point be asked strongly to consider switching to Fern.
Short positive plug-------i recently did a Sphinx to Fern conversion. Very clean, minimal changes, and lots of value on the side of faster publishing, easier for AI to scan docs to find what the user needs. Oh and some form of a much better search engine.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I haven't heard of fern! I will check it out.