Skip to content
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

Jump to bottom

doc: add more info to fs.Dir and fix typos #29890

Closed
wants to merge 1 commit into from
Closed

doc: add more info to fs.Dir and fix typos #29890

wants to merge 1 commit into from

Conversation

Fishrock123
Copy link
Contributor

Some doc bits / fixes which were missing from
cbd8d71

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@Fishrock123 Fishrock123 added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Oct 8, 2019
@Fishrock123 Fishrock123 requested a review from addaleax October 8, 2019 20:20
Trott
Trott reviewed Oct 9, 2019
View reviewed changes
doc/api/fs.md Outdated Show resolved Hide resolved
Trott
Trott reviewed Oct 9, 2019
View reviewed changes
doc/api/fs.md Outdated Show resolved Hide resolved
Trott
Trott reviewed Oct 9, 2019
View reviewed changes
doc/api/fs.md Outdated Show resolved Hide resolved
Trott
Trott approved these changes Oct 9, 2019
View reviewed changes
Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some relatively trivial comments, but would be fine if this lands as is, as it's definitely an improvement.

@Trott
Copy link
Member

Trott commented Oct 9, 2019

Left some relatively trivial comments, but would be fine if this lands as is, as it's definitely an improvement.

(Er, well, the 80-char wrapping will almost certainly have to happen unless the linter surprises me here....)

@Trott
Copy link
Member

Trott commented Oct 9, 2019

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3973/

@Trott
Copy link
Member

Trott commented Oct 9, 2019 •
edited
Loading

And...nope...the linter didn't complain about that long line.... should still be wrapped.... strange, though. If I add a line of all text that is longer than 80 chars, it complains. Maybe the new lint config skips over lines with links or something unexpected-to-me like that? /ping @nschonni

@nschonni
Copy link
Member

nschonni commented Oct 9, 2019

Looks like it doesn't count code content and links https://github.com/remarkjs/remark-lint/blob/1959381435f94ea0107df7e4242a969c1c55f2ff/packages/remark-lint-maximum-line-length/index.js#L114-L115

@Trott
Copy link
Member

Trott commented Oct 9, 2019

Looks like it doesn't count code content and links https://github.com/remarkjs/remark-lint/blob/1959381435f94ea0107df7e4242a969c1c55f2ff/packages/remark-lint-maximum-line-length/index.js#L114-L115

So any line that includes a link or inline code will not be checked for length? Oof. (Although I get it--URLs in particular can be longer than 80 chars just by themselves, so....)

@nschonni
Copy link
Member

nschonni commented Oct 9, 2019

It does check the length, but it ignores code blocks towards the total character count. If you add a few more to that line, then it will flag it. It doesn't look like there is an option to un-ignore those sections

BridgeAR
BridgeAR approved these changes Oct 9, 2019
View reviewed changes
Copy link
Member

@BridgeAR BridgeAR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with the nits addressed.

@Trott
Copy link
Member

Trott commented Oct 9, 2019

It does check the length, but it ignores code blocks towards the total character count. If you add a few more to that line, then it will flag it. It doesn't look like there is an option to un-ignore those sections

Without the code blocks, that line is still way over 80 characters. Without checking, I wonder if it's a bug where it's ignoring everything between the first and last ` rather than considering each matching pair of ``` ` ```` separately?

@Fishrock123 Fishrock123 mentioned this pull request Oct 9, 2019
Closed
3 tasks
@Fishrock123 Fishrock123 force-pushed the fs-dir-docs-amendments branch from f1bbc20 to 01d2a0b Compare October 9, 2019 18:42
@Fishrock123 Fishrock123 added the fast-track PRs that do not need to wait for 48 hours to land. label Oct 9, 2019
@Fishrock123
Copy link
Contributor Author

Fast tracking this would be desirable if possible since there is already another conflicting docs PR: #29906

(upvote this)

@Trott
Copy link
Member

Trott commented Oct 9, 2019

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3975/

@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 9, 2019
@Trott
Copy link
Member

Trott commented Oct 9, 2019

Argh, needs a rebase.

@Fishrock123
doc: add more info to fs.Dir and fix typos
02bc272 
Some doc bits / fixes which were missing from
cbd8d71
@Fishrock123 Fishrock123 force-pushed the fs-dir-docs-amendments branch from 01d2a0b to 02bc272 Compare October 9, 2019 22:17
@Fishrock123
Copy link
Contributor Author

Lite CI, post-rebase: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3979/

nschonni
nschonni reviewed Oct 9, 2019
View reviewed changes
doc/api/fs.md
@@ -293,8 +293,6 @@ A class representing a directory stream.

Created by [`fs.opendir()`][], [`fs.opendirSync()`][], or [`fsPromises.opendir()`][].

Example using async interation:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the typo in this one be fixed too instead of removing the line?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the line should be removed. In general, I dislike putting for example: and similar stuff before code that is obviously an example.

Trott pushed a commit that referenced this pull request Oct 10, 2019
@Fishrock123 @Trott
doc: add more info to fs.Dir and fix typos
b41989d 
Some doc bits / fixes which were missing from
cbd8d71

PR-URL: #29890
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@Trott
Copy link
Member

Trott commented Oct 10, 2019

Landed in b41989d

@Trott Trott closed this Oct 10, 2019
@Fishrock123 Fishrock123 deleted the fs-dir-docs-amendments branch October 10, 2019 07:15
BridgeAR pushed a commit that referenced this pull request Oct 10, 2019
@Fishrock123 @BridgeAR
doc: add more info to fs.Dir and fix typos
20b9ef9 
Some doc bits / fixes which were missing from
cbd8d71

PR-URL: #29890
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@BridgeAR BridgeAR mentioned this pull request Oct 10, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nschonni nschonni nschonni left review comments

@Trott Trott Trott approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

@cjihrig cjihrig cjihrig approved these changes

@lpinca lpinca lpinca approved these changes

@addaleax addaleax addaleax approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 48 hours to land. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@Fishrock123 @Trott @nschonni @jasnell @addaleax @lpinca @cjihrig @BridgeAR