Update some documentation that was out of sync #1164
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As I was updating some other code, the check_integrity script informed me that these three files were out of sync... and indeed they were! In the first one, there's a whole new usage pattern documented, and in the others an http has been changed to an https.
It's nice that the script worked now, but why hasn't it worked to prevent this in the CI, such as the recent runs of #1160 (after the new CI should be in place)? For that matter, why didn't it show up to me locally earlier? Did something else change? Perhaps the --newer flag should be removed from our invocation of git-utimes in check_integrity?
(Perhaps this PR shouldn't be accepted until there is at least one other commit past the CI-altering commit 4d2d393 in the git history (or at least has been attempted to be put in the git history), because maybe that would trigger the new CI and quell my doubts.)
Since I had to run the instructions to update each file, I noticed they were hard to copy-paste, and changed them to be easier.