Project

Profile

Help

Task #2319

closed

Add suffix to ProgressReport as an attribute and document it

Added by bmbouter over 6 years ago. Updated about 3 years 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
Quarter:

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/

Also available in: Atom PDF