jhudsl/ottr-reports

url-check flags urls when they're parenthetical

Closed this issue · 4 comments

Problem:

In one of my books, I've got a url listed in parentheses, like this:

 using the `swirl` package (https://swirlstats.com), which teaches students ...

The url checker reports this as broken because it grabs the closing parenthesis and comma like so:
https://swirlstats.com),

I could add it to my ignore file, but since this a url I'm linking to, it'd be nice if it got checked. And sticking a url in parentheses seems like something other people might want to do sometimes.

Here's the PR I'm working on

jhudsl/GDSCN_Book_swirl#26

We just got AnVIL_Template caught up to OTTR, and this PR is passing those updates on to my book. If I understand things correctly, I believe that means this PR is using the latest version of url check (i.e. the version in the PR, not the version in main)?

Resolved by #18

FYI @KatherineCox , please keep an eye on this in case I introduced a bug instead :)

Woot! Thanks @avahoffman!

@avahoffman

I'm not quite sure how things propagate from here through to AnVIL_Template - if I run a PR render right now in one of the AnVIL books does it use the most recent version of this ottr-reports action? Or do we need to update something in AnVIL_Template and send out a sync?

I've got another parenthetical URL with a slightly different form that's getting flagged in AnVIL_Instructor_Guide, but I don't know if it's using your updated version of the action:

Problem URL:

...makes it easier to incorporate version control (e.g., using [git](https://git-scm.com/)) and ensures...
Flagged as:
https://git-scm.com/)

PR link

PR is here: jhudsl/AnVIL_Book_Instructor_Guide#96
FYI, this PR is weird because we sent out updates from AnVIL_Template while it was open, so there are two copies of the URL comment - the one at the top of the PR is out of date, the one waaaaaay down the page (March 30) is the one that gets updated when the PR actions run.

@KatherineCox Each time the action is run in one of the course repos, it pulls from main here in ottr-reports (line here).. so no syncing needed :)

Let me see if I can reproduce this exception and write some code for it in a new PR.