Skip to content

Conversation

jsoref
Copy link
Contributor

@jsoref jsoref commented Oct 3, 2025

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)

jsoref added 8 commits October 3, 2025 16:17
```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>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@jsoref jsoref requested a review from a team as a code owner October 3, 2025 21:30
@wraithgar wraithgar self-assigned this Oct 3, 2025
@wraithgar wraithgar changed the title chore: Rewrap markdown docs docs: rewrap markdown Oct 3, 2025
`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`.
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 it missed an inline here.

Copy link
Contributor Author

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.

@wraithgar
Copy link
Member

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.

@wraithgar wraithgar merged commit 9ceb9c1 into npm:latest Oct 4, 2025
9 checks passed
@github-actions github-actions bot mentioned this pull request Oct 4, 2025
@jsoref jsoref deleted the rewrap-markdown-docs branch October 4, 2025 23:56
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