Update and improve another few URLs#1628
Merged
Byron merged 2 commits intoGitoxideLabs:mainfrom Oct 15, 2024
Merged
Conversation
This updates the "git_cmp_c" and "git_cmp_rs" links in the `gix_diff::tree::function::diff` documentation comment. - The significant change is to the "git_cmp_rs" link (the second link), which accounts for how files have renamed and how code has been moved, and also changed in GitoxideLabs#849 to fix issue GitoxideLabs#848. This hyperlink change completes the third task listed in GitoxideLabs#1627. - The other change is to update the "git_cmp_c" link at the same time. That code has not changed, and this is just referring to a later commit (the current tip of the master branch in git/git). The reason to also do this change is to make it easier to verify, both now and for anyone reading the documentation, that that link remains current.
The nonexistent repo used to get data from a 401 response in the `update-curl-fixtures` rule was formerly called `foo`. (In 1ea08bf in GitoxideLabs#1624, I had erroneously said this was for a 404 response, but the `foo` URL is the 401 URL, not the 404 URL.) This commit renames it to `nonexistent`, which is more self-documenting and less likely to be created by accident, even temporarily. In 1ea08bf (GitoxideLabs#1624), it was changed from `Byron/foo` to `GitoxideLabs/foo`, going along with the change of the existing repository (gitoxide's own) from `Byron/gitoxide` to `GitoxideLabs/gitoxide`. But while `Byron/foo` would continue not to exist as long as the convention of not having a `foo` repo was maintained by `@Byron`, a `foo` repository in `GitoxideLabs` might someday be created by another developer who is not aware of its status in `Makefile`. Renaming it to `nonexistent` should make this easier to avoid. I tested this change with the same approach as noted for 1ea08bf.
This was referenced Oct 14, 2024
Byron
approved these changes
Oct 15, 2024
Member
Byron
left a comment
There was a problem hiding this comment.
Thanks a lot for finding the new spot of these references :)!
This file contains hidden or 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
2 participants
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.
This builds on 65f69f7 (#1624, see also #1624 (comment)), completing the third task in #1627 (
gix-diff/src/tree/function.rs:27), fixing a broken link and updating another. See 991c939 for details.This does not do the first or second task of #1627 because I have not (yet?) figured out how. I think those improvements could go in another PR, once the best solution is figured out.
I've also improved on 1ea08bf (#1624) by giving the nonexistent repo used for a 401 response the more self-documenting name
nonexistent. See baa6f23 for the rationale and a few details.