-
Notifications
You must be signed in to change notification settings - Fork 3.7k
docs: rewrap markdown #8636
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
docs: rewrap markdown #8636
Conversation
```sh perl -pi -e ' if (/\`\`\`/) { $s = ! $s; next; }; next if $s; next if /^#/; s/([a-z)`]\.) +/$1\n/g; ' ``` x
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Visual Studio Code search and replace. Search: ([a-z])\n([a-z`])(?=[a-z]) Replace: $1 $2 Flags: Case-sensitive, Regular expression Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
perl -pi -e 's/^(\`\`\`[a-z]+)/$1\n/' Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
From previous changes that weren't careful enough about two spaces after periods. perl -pi -e 's/^ ([A-Z])/$1/' Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
This reverts commit 2b96821.
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
`npm doctor` hits a special connection testing endpoint within the registry. | ||
This can also be checked with `npm ping`. | ||
If this check fails, you may be using a proxy that needs to be configured, or may need to talk to your IT staff to get access over | ||
HTTPS to `registry.npmjs.org`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it missed an inline here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The unwrapping I'm doing doesn't handle capital letters at the beginning of a line, I just reviewed those manually. I ran out of time for the week and decided to post as is.
I'll do a few more passes through the same files to try to catch things like this. I may have to think about the right way to approach it. Perhaps any line that doesn't end with a .
/:
/!
/?
can be unwrapped... I already realized that lines that start with `
or that end with ,
still deserve to be unwrapped.
The missed inline isn't a blocker, just some feedback in case it matters to you w/ your script. This all looks good. Thank goodness for the GitHub rich diff function. "No visible changes here." sure made this easier to review. |
This is a first pass at rewrapping things. The patterns I'm using aren't fully complete, but they're definitely an improvement over the current content.
I don't have any more time today and may not have any time this coming week, but I'll try to do further passes when I have time...
References
Related to #8617 (comment)