doc: various documentation formatting fixes#7637
Merged
Uh oh!
There was an error while loading. Please reload this page.
Conversation
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
Member
addaleax commented Jul 9, 2016
Wanna squash addaleax/node@edb5c6a in here? LGTM either way. |
MemberAuthor
ChALkeR commented Jul 10, 2016
@addaleax Squashed, thanks! |
MemberAuthor
/cc @nodejs/documentation |
MemberAuthor
ChALkeR commented Jul 13, 2016
@nodejs/collaborators, will land this tomorrow if no objections. |
doc/api/fs.md Outdated
MemberAuthor
There was a problem hiding this comment.
It does highlight something, but not good.
Example:
$ cat script.js functionbad(){require('fs').readFile('/'); } bad(); $ env NODE_DEBUG=fs node script.js fs.js:88 throw backtrace; ^ Error: EISDIR: illegal operation on a directory, read<stack trace.>It's not a shell script, it's two shell commands + their output, and formatting the output as if it was a part of a shell script isn't a good idea imo.
Contributor
There was a problem hiding this comment.
console might work:
$ cat script.jsfunction bad(){ require('fs').readFile('/');}bad(); $ env NODE_DEBUG=fs node script.jsfs.js:88 throw backtrace; ^Error: EISDIR: illegal operation on a directory, read <stack trace.>MemberAuthor
There was a problem hiding this comment.
Hm, nice. Will check if our doc tooling supports it and will file a pull request to fix that if it is.
Thanks!
MemberAuthor
There was a problem hiding this comment.
This is how our doc tooling renders it:
That doesn't look good enough to me.
Contributor
There was a problem hiding this comment.
Hmm yeah, that sucks. Guess we should leave it at text until something better turns up :)
Contributor
silverwind commented Jul 13, 2016
LGTM with question |
* Fix markdown code sample in releases.md, it was <a id="x.y.x></a>" * Fix some markdown errors, e.g. in changelogs * Fix broken defs links, e.g. in domain-postmortem.md * Fix other broken refs, by addaleax * Add links to some defs that were present but not linked to * Remove dead defs * Move defs to the bottom (one file affected) * Add language indicators to all code blocks, using `txt` when no specific language could be chosen * Some minor formatting changes (spaces, ident, headings) PR-URL: nodejs#7637 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
MemberAuthor
ChALkeR commented Jul 14, 2016
Merged in a58b48b. |
1 task
Contributor
evanlucas commented Jul 15, 2016
This isn't landing cleanly on v6.x. Mind backporting? |
MemberAuthor
ChALkeR commented Jul 15, 2016
@evanlucas, will do. Perhaps after #7727 lands. |
ChALkeR added a commit to ChALkeR/io.js that referenced this pull request Aug 4, 2016
Continuing what a58b48b did for the doc/ dir, this fixes some formatting issues in the *.md files that are placed directly in the top-level directory. README.md changes are excluded as they are covered by nodejs#7971 Refs: nodejs#7637 PR-URL: nodejs#7727 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: James M Snell <[email protected]>
ChALkeR added a commit to ChALkeR/io.js that referenced this pull request Aug 7, 2016
Specifies the configuration for remark-lint, a markdown linter. This configuration does not cause any warnings on any of the currently present *.md files (ignoring thirdparty). It is useful not only for possible future tooling that would check the markdown files syntax, but also as a configuration for editor plugins, e.g. linter-markdown for atom-linter. Refs: nodejs#7637 Refs: nodejs#7727 Refs: nodejs#7757 PR-URL: nodejs#7729 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
cjihrig pushed a commit that referenced this pull request Aug 10, 2016
* Fix markdown code sample in releases.md, it was <a id="x.y.x></a>" * Fix some markdown errors, e.g. in changelogs * Fix broken defs links, e.g. in domain-postmortem.md * Fix other broken refs, by addaleax * Add links to some defs that were present but not linked to * Remove dead defs * Move defs to the bottom (one file affected) * Add language indicators to all code blocks, using `txt` when no specific language could be chosen * Some minor formatting changes (spaces, ident, headings) PR-URL: #7637 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Roman Reiss <[email protected]> Conflicts: doc/api/zlib.md doc/changelogs/CHANGELOG_V4.md
cjihrig pushed a commit that referenced this pull request Aug 10, 2016
Continuing what a58b48b did for the doc/ dir, this fixes some formatting issues in the *.md files that are placed directly in the top-level directory. README.md changes are excluded as they are covered by #7971 Refs: #7637 PR-URL: #7727 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: James M Snell <[email protected]>
cjihrig pushed a commit that referenced this pull request Aug 10, 2016
Specifies the configuration for remark-lint, a markdown linter. This configuration does not cause any warnings on any of the currently present *.md files (ignoring thirdparty). It is useful not only for possible future tooling that would check the markdown files syntax, but also as a configuration for editor plugins, e.g. linter-markdown for atom-linter. Refs: #7637 Refs: #7727 Refs: #7757 PR-URL: #7729 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
Merged
MylesBorins pushed a commit that referenced this pull request Sep 9, 2016
Specifies the configuration for remark-lint, a markdown linter. This configuration does not cause any warnings on any of the currently present *.md files (ignoring thirdparty). It is useful not only for possible future tooling that would check the markdown files syntax, but also as a configuration for editor plugins, e.g. linter-markdown for atom-linter. Refs: #7637 Refs: #7727 Refs: #7757 PR-URL: #7729 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
MylesBorins pushed a commit that referenced this pull request Sep 28, 2016
Specifies the configuration for remark-lint, a markdown linter. This configuration does not cause any warnings on any of the currently present *.md files (ignoring thirdparty). It is useful not only for possible future tooling that would check the markdown files syntax, but also as a configuration for editor plugins, e.g. linter-markdown for atom-linter. Refs: #7637 Refs: #7727 Refs: #7757 PR-URL: #7729 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
Contributor
MylesBorins commented Sep 30, 2016
@ChALkeR setting don't land for v4.x let me know if you want to backport |
rvagg pushed a commit that referenced this pull request Oct 18, 2016
Specifies the configuration for remark-lint, a markdown linter. This configuration does not cause any warnings on any of the currently present *.md files (ignoring thirdparty). It is useful not only for possible future tooling that would check the markdown files syntax, but also as a configuration for editor plugins, e.g. linter-markdown for atom-linter. Refs: #7637 Refs: #7727 Refs: #7757 PR-URL: #7729 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
MylesBorins pushed a commit that referenced this pull request Oct 26, 2016
Specifies the configuration for remark-lint, a markdown linter. This configuration does not cause any warnings on any of the currently present *.md files (ignoring thirdparty). It is useful not only for possible future tooling that would check the markdown files syntax, but also as a configuration for editor plugins, e.g. linter-markdown for atom-linter. Refs: #7637 Refs: #7727 Refs: #7757 PR-URL: #7729 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment
7 participants
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.
Checklist
Affected core subsystem(s)
doc
Description of change
<a id="x.y.x></a>"txtwhen nospecific language could be chosen