diff --git a/datalad_next/patches/cli_configoverrides.py b/datalad_next/patches/cli_configoverrides.py index 59276b5d..b553854e 100644 --- a/datalad_next/patches/cli_configoverrides.py +++ b/datalad_next/patches/cli_configoverrides.py @@ -1,3 +1,10 @@ +"""Post DataLad config overrides CLI/ENV as GIT_CONFIG items in process ENV + +This enables their propagation to any subprocess. This includes the +specification of overrides via the ``datalad -c ...`` option of the +main CLI entrypoint. +""" + from datalad.config import _update_from_env as _update_from_datalad_env from datalad.cli.helpers import _parse_overrides_from_cmdline diff --git a/datalad_next/patches/commanderror.py b/datalad_next/patches/commanderror.py index daef7dc6..eb42182a 100644 --- a/datalad_next/patches/commanderror.py +++ b/datalad_next/patches/commanderror.py @@ -1,3 +1,11 @@ +"""Improve ``CommandError`` rendering + +Without this patch that overwrites ``__repr__``, it would use +``RuntimeError``'s variant and ignore all additional structured information +except for ``.msg`` -- which is frequently empty and confuses with a +`CommandError('')` display. +""" + from datalad.runner.exception import CommandError @@ -5,7 +13,4 @@ def commanderror_repr(self) -> str: return self.to_str() -# without overwriting __repr__ it would use RuntimeError's variant -# with ignore all info but `.msg` which will be empty frequently -# and confuse people with `CommandError('')` CommandError.__repr__ = commanderror_repr diff --git a/datalad_next/patches/create_sibling_gitlab.py b/datalad_next/patches/create_sibling_gitlab.py index c4c8974f..971953dc 100644 --- a/datalad_next/patches/create_sibling_gitlab.py +++ b/datalad_next/patches/create_sibling_gitlab.py @@ -1,5 +1,7 @@ -""" +"""Streamline user experience +Discontinue advertizing the ``hierarchy`` layout, and better explain +limitations of the command. """ import datalad.distributed.create_sibling_gitlab as mod_gitlab diff --git a/docs/source/developer_guide/index.rst b/docs/source/developer_guide/index.rst index 1ae91c6a..25c39878 100644 --- a/docs/source/developer_guide/index.rst +++ b/docs/source/developer_guide/index.rst @@ -1,7 +1,7 @@ .. _devguide: -The developer's guide to datalad-next -************************************* +Developer Guide +=============== This guide sheds light on new and reusable subsystems developed in ``datalad-next``. The target audience are developers that intend to build up on or use functionality provided by this extension. @@ -10,4 +10,4 @@ The target audience are developers that intend to build up on or use functionali :maxdepth: 2 constraints.rst - contributing.rst \ No newline at end of file + contributing.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 86db9be4..fea42812 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -29,82 +29,24 @@ extension has to be enabled for auto-loading by executing:: Doing so will enable the extension to also alter the behavior the core DataLad package and its commands. -API -=== -High-level API commands ------------------------ +Provided functionality +====================== .. toctree:: - :maxdepth: 2 + :maxdepth: 1 api.rst - -Command line reference ----------------------- - -.. toctree:: - :maxdepth: 2 - cmd.rst - - -Python tooling --------------- - -``datalad-next`` comprises a number of more-or-less self-contained -mini-packages providing particular functionality. - -.. toctree:: - :maxdepth: 1 - Infrastructure classes and utilities - - -Git remote helpers ------------------- - -.. toctree:: - :maxdepth: 2 - git-remote-helpers.rst - - -Git-annex backends ------------------- - -.. toctree:: - :maxdepth: 2 - annex-backends.rst - - - -Git-annex special remotes -------------------------- - - -.. toctree:: - :maxdepth: 2 - annex-specialremotes.rst - - - -DataLad patches ---------------- - -Patches that are automatically applied to DataLad when loading the -``datalad-next`` extension package. - -.. toctree:: - :maxdepth: 2 - patches.rst -Developer Guide ---------------- +Contributor information +======================= .. toctree:: :maxdepth: 2 diff --git a/docs/source/patches.rst b/docs/source/patches.rst index a7553cf4..33654513 100644 --- a/docs/source/patches.rst +++ b/docs/source/patches.rst @@ -1,19 +1,26 @@ DataLad patches *************** +Patches that are automatically applied to DataLad when loading the +``datalad-next`` extension package. + .. currentmodule:: datalad_next.patches .. autosummary:: :toctree: generated annexrepo + cli_configoverrides + commanderror common_cfg configuration create_sibling_ghlike + create_sibling_gitlab customremotes_main distribution_dataset interface_utils push_optimize push_to_export_remote - test_keyring - siblings run + siblings + test_keyring + update