Skip to content

fix: MD038/no-space-in-code #2362

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.

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
wants to merge 0 commits into from

Conversation

nschonni
Copy link
Member

@nschonni nschonni commented Aug 5, 2019

Spaces inside code span elements

@@ -121,7 +121,7 @@ Semver Patch:
* [[`b08ff33c01`](https://github.com/nodejs/node/commit/b08ff33c01)] - **doc**: add `added:` information for https (Anna Henningsen) [#7392](https://github.com/nodejs/node/pull/7392)
* [[`1d99059bb1`](https://github.com/nodejs/node/commit/1d99059bb1)] - **doc**: add `added:` information for dns (Julian Duque) [#7021](https://github.com/nodejs/node/pull/7021)
* [[`a0ca24b798`](https://github.com/nodejs/node/commit/a0ca24b798)] - **doc**: add `added:` information for console (Adrian Estrada) [#6995](https://github.com/nodejs/node/pull/6995)
* [[`eb08c17a20`](https://github.com/nodejs/node/commit/eb08c17a20)] - **doc**: add `added: ` data for cli.md (Rich Trott) [#6960](https://github.com/nodejs/node/pull/6960)
* [[`eb08c17a20`](https://github.com/nodejs/node/commit/eb08c17a20)] - **doc**: add `added:` data for cli.md (Rich Trott) [#6960](https://github.com/nodejs/node/pull/6960)
Copy link
Member

Choose a reason for hiding this comment

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

Maybe it's best to omit blog/release/* from the linting. The text being changed here is directly from the commit log. Even if there are typographical errors in the commit log, I think it's best that the text match.

(Alternatively, maybe we can add an HTML comment that instructs the linter to skip this line? No idea if the tool we're using permits that but remark-lint does, so maybe this one does too?)

Copy link
Member Author

Choose a reason for hiding this comment

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

It can be ignored from the command line glob, but that would still show up in IDEs. A disable command could be added to the files/template to disable it in the files by adding <!-- markdownlint-disable--> or for specific rules

Copy link
Member

Choose a reason for hiding this comment

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

Just to get this PR landed, can you add a comment to disable it for these lines in the changelog rather than altering the lines?

Copy link
Member Author

Choose a reason for hiding this comment

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

OK, I guess a different approach might be needed for #2360

Copy link
Member Author

Choose a reason for hiding this comment

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

I've disabled it at the file level

@nschonni nschonni closed this Aug 5, 2019
@nschonni nschonni force-pushed the fix--MD038/no-space-in-code branch from aef2768 to 332f84d Compare August 5, 2019 18:32
@nschonni
Copy link
Member Author

nschonni commented Aug 5, 2019

Arg, GitHub decided to close the PR on a force push. Looks like a new service glitch/bug, so I'll need to resubmit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants