Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Key interface documentation #6391

Merged
merged 3 commits into from Feb 1, 2022
Merged

Key interface documentation #6391

merged 3 commits into from Feb 1, 2022

Conversation

mih
Copy link
Member

@mih mih commented Jan 29, 2022

Changelog

馃摑 Documentation

  • The datalad.interface.base.Interface class, the basis of all DataLad command implementations, has been extensively documented to provide an overview of basic principles and customization possibilities (by @mih)

馃獡 Deprecations and removals

  • datalad.interface.common_opts.eval_default has been deprecated. All (command-specific) defaults for common interface parameters can be read from Interface class attributes (by @mih)

馃彔 Internal

  • datalad.interface.base.Interface is now an abstract class #6391 (by @mih)

@mih mih added CHANGELOG-missing When a PR's description does not contain a changelog item, yet. documentation Documentation-related issue team-core core API/commands (https://github.com/datalad/datalad/issues/6365) semver-documentation Changes only affect the documentation, no impact on version labels Jan 29, 2022
@codecov
Copy link

codecov bot commented Jan 29, 2022

Codecov Report

Merging #6391 (d5988e2) into master (c2183b3) will decrease coverage by 0.05%.
The diff coverage is 100.00%.

鉂 Current head d5988e2 differs from pull request most recent head 4fb034e. Consider uploading reports for the commit 4fb034e to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##           master    #6391      +/-   ##
==========================================
- Coverage   89.94%   89.89%   -0.06%     
==========================================
  Files         344      342       -2     
  Lines       43286    43107     -179     
==========================================
- Hits        38934    38751     -183     
- Misses       4352     4356       +4     
Impacted Files Coverage 螖
datalad/cli/tests/test_exec.py 98.80% <酶> (酶)
datalad/interface/utils.py 90.81% <酶> (-0.04%) 猬囷笍
datalad/cli/common_args.py 100.00% <100.00%> (酶)
datalad/interface/base.py 90.25% <100.00%> (+0.25%) 猬嗭笍
datalad/interface/common_opts.py 100.00% <100.00%> (酶)
datalad/local/subdatasets.py 93.75% <0.00%> (-2.35%) 猬囷笍
datalad/ui/dialog.py 87.70% <0.00%> (-2.14%) 猬囷笍
datalad/interface/__init__.py 100.00% <0.00%> (酶)
datalad/local/tests/test_configuration.py
datalad/local/configuration.py

Continue to review full report at Codecov.

Legend - Click here to learn more
螖 = absolute <relative> (impact), 酶 = not affected, ? = missing data
Powered by Codecov. Last update c2183b3...4fb034e. Read the comment docs.

Copy link
Contributor

@mslw mslw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The implementation is too much for me to dive into, but I've gone through the design document. I think it clearly explains what is happening and why - I was able to get an impression of the interface. I only have minor typo fixes.

docs/source/design/cli.rst Outdated Show resolved Hide resolved
docs/source/design/cli.rst Outdated Show resolved Hide resolved
docs/source/design/cli.rst Outdated Show resolved Hide resolved
docs/source/design/cli.rst Outdated Show resolved Hide resolved
@mih mih mentioned this pull request Feb 1, 2022
7 tasks
mih and others added 3 commits February 1, 2022 08:23
The default are more productively put into the Interface class directly.
The makes the documentation more accessible, makes more obvious where
overrides need to go, reduces the number of places that need to be
queried in order to determine the effective value.
Co-authored-by: Micha艂 Szczepanik <mslw92@gmail.com>
@codeclimate
Copy link

codeclimate bot commented Feb 1, 2022

Code Climate has analyzed commit 4fb034e and detected 1 issue on this pull request.

Here's the issue category breakdown:

Category Count
Security 1

View more on Code Climate.

@mih mih removed the CHANGELOG-missing When a PR's description does not contain a changelog item, yet. label Feb 1, 2022
@mih
Copy link
Member Author

mih commented Feb 1, 2022

@mslw I have incorporated all your suggestions. Thx!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation-related issue semver-documentation Changes only affect the documentation, no impact on version team-core core API/commands (https://github.com/datalad/datalad/issues/6365)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Turn Interface into an abstract class
2 participants