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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Design document on progress reporting #6734

Merged
merged 3 commits into from
Jun 7, 2022
Merged

Design document on progress reporting #6734

merged 3 commits into from
Jun 7, 2022

Conversation

mih
Copy link
Member

@mih mih commented Jun 1, 2022

Changelog

📝 Documentation

  • New design document on progress reporting.

@mih mih added the semver-documentation Changes only affect the documentation, no impact on version label Jun 1, 2022
@codecov
Copy link

codecov bot commented Jun 1, 2022 •
edited
Loading

Codecov Report

Merging #6734 (3fac51b) into master (d657c17) will increase coverage by 1.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #6734      +/-   ##
==========================================
+ Coverage   88.79%   89.80%   +1.01%     
==========================================
  Files         353      353              
  Lines       45744    45761      +17     
==========================================
+ Hits        40617    41096     +479     
+ Misses       5127     4665     -462
Impacted Files Coverage Δ
datalad/ui/utils.py 50.00% <0.00%> (-19.45%) ⬇️
datalad/metadata/extractors/tests/test_base.py 87.80% <0.00%> (-12.20%) ⬇️
datalad/support/archive_utils_patool.py 29.87% <0.00%> (-10.39%) ⬇️
datalad/local/tests/test_wtf.py 90.47% <0.00%> (-8.31%) ⬇️
datalad/metadata/extractors/tests/test_xmp.py 92.59% <0.00%> (-7.41%) ⬇️
datalad/support/cookies.py 80.88% <0.00%> (-7.36%) ⬇️
datalad/core/local/tests/test_results.py 92.85% <0.00%> (-7.15%) ⬇️
datalad/downloaders/tests/test_http.py 87.76% <0.00%> (-6.59%) ⬇️
datalad/cli/main.py 76.00% <0.00%> (-6.00%) ⬇️
datalad/support/tests/test_path.py 92.30% <0.00%> (-5.13%) ⬇️
... and 48 more

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 d657c17...3fac51b. Read the comment docs.

@bpoldrack
Copy link
Member

Thanks much!

yarikoptic
yarikoptic reviewed Jun 1, 2022
View reviewed changes
Copy link
Member

@yarikoptic yarikoptic left a comment

Choose a reason for hiding this comment

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

coolio, thanks! Left some suggested edits / comments

docs/source/design/progress_reporting.rst Outdated Show resolved Hide resolved
docs/source/design/progress_reporting.rst Outdated Show resolved Hide resolved
docs/source/design/progress_reporting.rst Outdated Show resolved Hide resolved
docs/source/design/progress_reporting.rst Outdated Show resolved Hide resolved
docs/source/design/progress_reporting.rst Outdated Show resolved Hide resolved
docs/source/design/progress_reporting.rst Outdated Show resolved Hide resolved
docs/source/design/progress_reporting.rst Show resolved Hide resolved
docs/source/design/progress_reporting.rst Outdated Show resolved Hide resolved
@adswa
Copy link
Member

adswa commented Jun 1, 2022

This is super helpful!

@adswa
Copy link
Member

adswa commented Jun 1, 2022

this is so helpful, thanks!

adswa added a commit to adswa/datalad that referenced this pull request Jun 3, 2022
@adswa
ENH: Improve add-archive-contents progressbar following datalad#6735 & …
f8ab6c5 
…datalad#6734
@adswa adswa mentioned this pull request Jun 3, 2022
Merged
@codeclimate
Copy link

codeclimate bot commented Jun 3, 2022

Code Climate has analyzed commit f5b8e3c and detected 0 issues on this pull request.

View more on Code Climate.

mih added a commit to mih/datalad that referenced this pull request Jun 4, 2022
@mih
A bit more clarity for the log_progress() docs
2faad43 
Main update of related docs is coming via
datalad#6734
adswa added a commit that referenced this pull request Jun 7, 2022
@adswa
Merge pull request #6739 from adswa/enh-progress-addarchivecontent
96a8584 
ENH: Improve add-archive-contents progressbar following #6735 & #6734
@yarikoptic
Copy link
Member

I guess this PR is the best descriptor of progress bars behavior.. if any further enhancements to be done -- could follow in a PR. Let's proceed. Thanks @mih!

@yarikoptic yarikoptic merged commit 40897ef into datalad:master Jun 7, 2022
@mih
Copy link
Member Author

mih commented Jun 7, 2022

thx

@mih mih mentioned this pull request Jul 1, 2022
Closed
40 tasks
@mih mih deleted the progressdocs branch July 19, 2022 11:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yarikoptic yarikoptic yarikoptic left review comments

Assignees
No one assigned
Labels
semver-documentation Changes only affect the documentation, no impact on version
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mih @bpoldrack @adswa @yarikoptic