Fix a doc in gix_path::convert, revise others, and refactor slightly
#1843
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
The `gix_path::convert::to_windows_separators` documentation comment had inadvertently described the opposite of what this function does, saying it changed backslashed to slashes and that the effect was like a Unix path. This fixes the docstring so it saye `to_windows_separators` changes slashes to backslashes, and moves the text that likens it to paths on Unix to the `to_unix_separators` docstring, where it applies. This also makes a number of other more minor revisions for clarity and stylistic consistency to documentation comments on other functions in the `gix_path::convert` module.
`to_native_path_on_windows` already called `to_windows_separators` to do what would otherwise repeat logic of `to_windows_separators`, but `to_unix_separators_on_windows` repeated the code of `to_unix_separators`. Having `to_unix_separators_on_windows` call `to_unix_separators` instead of repeating its logic seems slightly easier to read, elucidates the relationship between the several functions, and might be slightly more maintainable. This is purely a refactoring, which should not change the effect. It should also not change performance, since the compiler should be able to inline the call in circumstnaces where that would help.
|
Thanks a lot, so much better than before! |
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.
This fixes a docstring that inadvertently described a different function with an opposite effect, revises others for clarity and stylistic consistency, and refactors to slightly decrease code duplication while elucidating the relationship between functions. More details are in the commit messages.
(It feels a bit silly to open this as a separate pull request from #1841, rather than including these changes there, but I think the considerations for reviewing these two pull requests are completely independent. Having this separate may also make it possible to review it even if it's not immediately clear whether #1841 should be accepted. Even though some nearby lines are changed, they aren't adjacent, so I think there is no merge conflict.)