GeezerVisonThe World Wide Web, restored to 800 pixels of glory. | ||||||
| Home|About|Gaming cabinet|Archives|How it works|Starter sites | ||||||
GeezerVison is showing github.com — doc: typography mistake by kovsu · Pull Request #45398 · nodejs/node Conversation
Collaborator
All reactions
Sorry, something went wrong. Uh oh!
There was an error while loading. Please reload this page.
Trott
requested changes
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not a spelling mistake although it is awkward typography.
Sorry, something went wrong. Uh oh!
There was an error while loading. Please reload this page. All reactions
|
There was an error while loading. Please reload this page.
|
The backticks do not render as punctuation. They are there for formatting/typography. It should be reworded though, because using the keyword as a verb is weird. Instead of "required" maybe we can say: imported via `require()` ...or: included via `require()` ...or something like that. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
I don't know how to express it 😀. And thanks for immediately correcting my mistake. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Do we have an official way of styling this? For example, (outside of nodejs docs) I write
require()ed
imported
import()ed
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
I've been looking for guidance in the Microsoft Style Guide (which we try to follow) but haven't found any. My personal opinion, though, is that we should avoid using function names as verbs.
For these reasons (and probably a few other reasons I haven't thought of), I think it's best to use a separate verb and let the function name be what it actually is, which is a noun. It might be good to standardize for some specific cases, though. This PR uses "included via |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
I think it would be good to establish some kind of policy, otherwise we'll end up with a bunch of these issues/PRs. Colloquial English turns pretty much any word into a verb/past-participle by just adding "ed" to the end, so I think it's acceptable here. RE confusion about to what it's referring, that's why I include the parentheses: But I'm also totally fine with "included via |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
Landed in c4d75ea |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
PR-URL: #45398 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Jacob Smith <[email protected]>
PR-URL: #45398 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Jacob Smith <[email protected]>
PR-URL: #45398 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Jacob Smith <[email protected]>
There was an error while loading. Please reload this page.
Successfully merging this pull request may close these issues.
There was an error while loading. Please reload this page.