Project

Profile

Help

Task #2319

Add suffix to ProgressReport as an attribute and document it

Added by bmbouter over 3 years ago. Updated 7 months ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Category:
-
Sprint/Milestone:
Start date:
Due date:
% Done:

100%

Estimated time:
Platform Release:
Groomed:
Yes
Sprint Candidate:
Yes
Tags:
Sprint:
Sprint 11

Description

The progress library supports very nice syntax[0] for the suffix of progress bars. We should add a suffix attribute to a ProgressReport and encourage plugin writers to provide a suffix string. This way each progress report can be rendered exactly how they want their progress to be shown. This field should default to None.

The ProgressReport class docstring should be updated with examples. I think copying the table from the progress documentation would be good, but maybe we should just link to the documentation[0].

[0]: https://github.com/verigak/progress/

Associated revisions

Revision fa6c0057 View on GitHub
Added by ipanova@redhat.com over 3 years ago

Add a suffix attribute to the ProgressReport model.

closes #2319 https://pulp.plan.io/issues/2319

Revision fa6c0057 View on GitHub
Added by ipanova@redhat.com over 3 years ago

Add a suffix attribute to the ProgressReport model.

closes #2319 https://pulp.plan.io/issues/2319

Revision a42a3dba View on GitHub
Added by bmbouter over 3 years ago

re #2319: Fixes 3.0-dev docs error

The external link was not formatted correctly.

https://pulp.plan.io/issues/2319

Revision a42a3dba View on GitHub
Added by bmbouter over 3 years ago

re #2319: Fixes 3.0-dev docs error

The external link was not formatted correctly.

https://pulp.plan.io/issues/2319

Revision f160dd00 View on GitHub
Added by bmbouter over 3 years ago

Merge pull request #2893 from bmbouter/fix-3.0-dev-docs-builder

re #2319: Fixes 3.0-dev docs error

Revision f160dd00 View on GitHub
Added by bmbouter over 3 years ago

Merge pull request #2893 from bmbouter/fix-3.0-dev-docs-builder

re #2319: Fixes 3.0-dev docs error

History

#1 Updated by mhrivnak over 3 years ago

  • Groomed changed from No to Yes

#2 Updated by mhrivnak over 3 years ago

  • Sprint/Milestone set to 29

#3 Updated by ipanova@redhat.com over 3 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to ipanova@redhat.com

#4 Updated by ipanova@redhat.com over 3 years ago

  • Subject changed from Add suffix to ProgressBar as an attribute and document it to Add suffix to ProgressReport as an attribute and document it

#5 Updated by ipanova@redhat.com over 3 years ago

  • Status changed from ASSIGNED to POST

#6 Updated by ipanova@redhat.com over 3 years ago

  • Status changed from POST to MODIFIED
  • % Done changed from 0 to 100

#7 Updated by bmbouter over 2 years ago

  • Sprint set to Sprint 11

#8 Updated by bmbouter over 2 years ago

  • Sprint/Milestone deleted (29)

#9 Updated by daviddavis about 1 year ago

  • Sprint/Milestone set to 3.0.0

#10 Updated by bmbouter about 1 year ago

  • Tags deleted (Pulp 3)

#11 Updated by bmbouter 7 months ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

Please register to edit this issue

Also available in: Atom PDF