Apply rule from issue #465 to core document.rs

[hippietrail]

when best-effort is an adjective it should by connected using a hyphen

[ccoVeille]

Two remarks:

First, using a reference such as #465 (I'm using back ticks on purpose here) in the PR title doesn't create a link between the issues: ypu have to use the description or comment

Then, a PR title should be meaningful. add rule for #465 is not. I help to find back what it's about.

Especially if you consider the PRs might at some point have the same format. Consider having such a list:

• add rule for #465
• fix for #462, and add #432
• revert #433
  ...

[hippietrail]

Two remarks:

First, using a reference such as #465 (I'm using back ticks on purpose here) in the PR title doesn't create a link between the issues: ypu have to use the description or comment

Then, a PR title should be meaningful. add rule for #465 is not. I help to find back what it's about.

Especially if you consider the PRs might at some point have the same format. Consider having such a list:

• add rule for #465
• fix for #462, and add #432
• revert #433
  ...

Thanks. I'm still struggling with git and github but I thought this was showing that it did create a link:

This PR doesn't add any rule, it's just fixing spelling which happens to be the same spelling issue I made that PR about. Most of my spelling/typo/grammar PRs have been very short-lived so I wasn't as careful with the wording as with feature PRs.

[ccoVeille]

Nothing is short lived.

Once the PR will be merged, they will stay forever

[ccoVeille]

Thanks. I'm still struggling with git and github but I thought this was showing that it did create a link:

The commit did, because you mentioned the issue in it. But not the PR

Take a look here.

You did it right

You mentioned in the description

And then in the issue, you get a mention of the PR

[hippietrail]

If I'm following you, those I did that way because git & github seem to want commit messages to be very short so I tried to make them information-dense without being long. But maybe I'm second-guessing how it's supposed to work while I struggle to learn?

I think I'm still confused. The ones with the green underline are a mix of mine and others' - are these examples of the right way to do it?

Update: I think one part of what confuses me is which are the same/different among concepts like PR title, commit message, body, description. When I commit from VS Code there's a one-line box for a commit message. Then after pushing my branch I had been to the GitHub website and put in some additional details if needed. I think I don't yet have a solid 100% grip on what's part of Git, what's part of GitHub, and what's additional or limited by VS Code's integration.

Thanks for your patience!