search

mongodb / specifications

Specifications related to MongoDB
http://specifications.readthedocs.io/en/latest
Other
389 stars 242 forks source link

DRIVERS-2789 Add script to check for malformed links #1637

Closed blink1073 closed 2 months ago

blink1073 commented 2 months ago

Please complete the following before merging:

blink1073 commented 2 months ago

just as a sanity check - could you add a commit to this PR with a broken link to demo it getting caught by this script?

I did that locally

dariakp commented 2 months ago

just as a sanity check - could you add a commit to this PR with a broken link to demo it getting caught by this script?

I did that locally

Of course, my thought was just that since these checks will run in GH on the PR itself, we have an opportunity to run the "test" in CI as well, capturing the red x next to the test commit for posterity, instead of just relying on local execution.

Anyway, that's fine. Is there any concern about this script accidentally catching distributed brackets in code snippets?

blink1073 commented 2 months ago

Of course, my thought was just that since these checks will run in GH on the PR itself, we have an opportunity to run the "test" in CI as well, capturing the red x next to the test commit for posterity, instead of just relying on local execution.

I've been using "rebase and merge" to make sure I don't miss the RST->MD renaming commit, and I don't want to accidentally forget to change it back after using a "squash and merge" on a PR.

Is there any concern about this script accidentally catching distributed brackets in code snippets?

Good call, I'll add detection of whether we're in a code block.

blink1073 commented 2 months ago

I verified this behavior locally as well.