Fix docstring about "getting subdatasets" in get #7460
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
The docstring said the property is remote-<name>, while the code in _get_flexible_source_candidates_for_submodule() used remoteurl-name.
The doctrings for get and its helper function _get_flexible_source_candidates_for_submodule() seem to have diverged w.r.t. the default costs for subdataset source candidates. This commit brings them back in line by updating get's docstring. Some changes to cost values happened e.g. in 9138af0 After a cursory look, I am under the impression that the values reported in helper function's docstring match its code, and as long as they aren't modified elsewhere these would be the valid ones for get.
mslw
added
the
CHANGELOG-missing
github-actions
bot
removed
the
CHANGELOG-missing
mslw
added
the
semver-documentation
mslw
changed the title
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## maint #7460 +/- ##
==========================================
+ Coverage 90.73% 91.34% +0.60%
==========================================
Files 325 325
Lines 43399 43399
Branches 0 5818 +5818
==========================================
+ Hits 39380 39642 +262
+ Misses 4019 3742 -277
- Partials 0 15 +15
☔ View full report in Codecov by Sentry. |
loj
approved these changes
Jul 31, 2023
4 tasks
|
FTR, I see there were errors in the CI runs on CrippledFS 1 and part of Travis runs 2 (though not Appveyor). Given that the PR is docstring-only, I supose they have to be indicative of something unrelated, but I will not have the resources to debug them, and I consider this small PR complete. Footnotes |
|
Looks LGTM to me, let's proceed! |
|
PR released in |
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 docstring-only PR:
remote-<name>→remoteurl-<name>, matching the code)getdocstring (i.e. manpage for get), so that they are the same as in the helper function docstring (_get_flexible_source_candidates_for_submodule().Regarding the latter: The doctrings for
getand its helper function seem to have diverged w.r.t. the default costs for subdataset source candidates. Some changes to cost values happened e.g. in 9138af0. After a cursory look, I am under the impression that the values reported in helper function's docstring match its code (or at least are closer to truth), and as long as they aren't modified elsewhere these would be the valid ones for get.Fixes #7458