223031012
/
DAMASK_EICMD
mirror of https://github.com/achalhp/DAMASK_EICMD.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[skip ci] polishing of doc string

This commit is contained in:
Philip Eisenlohr 2021-05-10 14:44:58 -04:00
parent bc8a03b392
commit d6e69d5d4b
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
python/damask/util.py
View File

@ -195,20 +195,20 @@ def natural_sort(key):
def show_progress(iterable,N_iter=None,prefix='',bar_length=50): def show_progress(iterable,N_iter=None,prefix='',bar_length=50):
""" """
Decorate a loop with a status bar. Decorate a loop with a progress bar.
Use similar like enumerate. Use similar like enumerate.
Parameters Parameters
---------- ----------
iterable : iterable/function with yield statement iterable : iterable or function with yield statement
Iterable (or function with yield statement) to be decorated. Iterable (or function with yield statement) to be decorated.
N_iter : int, optional N_iter : int, optional
Total # of iterations. Needed if number of iterations can not be obtained as len(iterable). Total number of iterations. Required unless obtainable as len(iterable).
prefix : str, optional prefix : str, optional
Prefix string. Prefix string.
bar_length : int, optional bar_length : int, optional
Character length of bar. Defaults to 50. Length of progress bar in characters. Defaults to 50.
""" """
if N_iter in [0,1] or (hasattr(iterable,'__len__') and len(iterable) <= 1): if N_iter in [0,1] or (hasattr(iterable,'__len__') and len(iterable) <= 1):