New config manager #760
Closed
New config manager #760
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
mih
force-pushed
the
configman
branch
3 times, most recently
from
2d48c2d to
2f0d377
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #760 +/- ##
===========================================
- Coverage 79.72% 23.07% -56.66%
===========================================
Files 185 195 +10
Lines 12410 13333 +923
Branches 2162 2447 +285
===========================================
- Hits 9894 3076 -6818
- Misses 2263 10175 +7912
+ Partials 253 82 -171 ☔ View full report in Codecov by Sentry. |
Previously, the setup was confusing. Every symbol imported to module level was documented directly. If a ToC was added, sphinx would fail due to documentation generated twice for the same symbol. The new setup **requires** a dedicated autosummary selection of documented content. I think this is better. Often modules provide a lot of stuff, and direct documentation rendering on a single page is overwhelming. The explicit selection also allows for items to be excluded that are only there for technical or historical reasons. This allows for an overall more accessible documentation.
mih
force-pushed
the
configman
branch
3 times, most recently
from
2ebc8bc to
f861e76
Compare
mih
force-pushed
the
configman
branch
3 times, most recently
from
1219605 to
3751fbb
Compare
mih
force-pushed
the
configman
branch
3 times, most recently
from
a911859 to
c4c8e9f
Compare
We have no other choice, but to modify them. Even for the legacy adaptor, we do not want to maintain senseless complexities. The changes in the tests will document the exact differences.
This will eventually fix datalad#397
5 tasks
|
This PR has served its purpose and I will close it now. A config manager like it was proposed here is now part of datalad-core: datalad/datalad-core#19 If there is a desired to include the configuration manager adapter as a semi-long-lived transition helper, it could be taken from here and rebased on datalad-core. However, it is unclear to me if that is even useful. In any case, this PR has shown that it is possible. |
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.
TODO:
Remaining issues for replacing the legacy
ConfigManagerwith the actual newLegacyConfigManagerFAILED datalad_next/patches/tests/test_cli_configoverrides.py::test_cli_configoverrides - AttributeError: 'mappingproxy' object has no attribute 'update'
FAILED datalad_next/annexremotes/tests/test_archivist.py::test_archivist_retrieval - datalad.runner.exception.CommandError: CommandError: 'git -c diff.ignoreSubmo...