Skip to content

doc: address various uses of "obvious" and "obviously" #32457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Trott wants to merge 3 commits into from
Closed

doc: address various uses of "obvious" and "obviously" #32457

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ab1efab
doc: trim wording in n-api.md text about exceptions
Trott Mar 24, 2020
5e350bc
doc: remove unnecessary "obvious(ly)" modifiers in esm.md
Trott Mar 24, 2020
76f399e
doc: remove extraneous sentence in events.md
Trott Mar 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: remove unnecessary "obvious(ly)" modifiers in esm.md 
Remove "obvious" and "obviously" in two places in esm.md. It may be
obvious to some, but likely not everyone or else it probably wouldn't be
worth mentioning/documenting.
  • Loading branch information
@Trott
Trott committed Mar 24, 2020
commit 5e350bcd8d48bf059fb0990d192250e1d56ea18a
4 changes: 2 additions & 2 deletions doc/api/esm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -518,7 +518,7 @@ would be usable by any version of Node.js, since `import` can refer to CommonJS
files; but it would not provide any of the advantages of using ES module syntax.

A package could also switch from CommonJS to ES module syntax in a breaking
change version bump. This has the obvious disadvantage that the newest version
change version bump. This has the disadvantage that the newest version
of the package would only be usable in ES module-supporting versions of Node.js.

Every pattern has tradeoffs, but there are two broad approaches that satisfy the
Expand Down Expand Up @@ -1344,7 +1344,7 @@ JavaScript using the [`transformSource` hook][]. Before that hook gets called,
however, other hooks need to tell Node.js not to throw an error on unknown file
types; and to tell Node.js how to load this new file type.

This is obviously less performant than transpiling source files before running
This is less performant than transpiling source files before running
Node.js; a transpiler loader should only be used for development and testing
purposes.

Expand Down