Skip to content

fix timing utility docstrings for tic toc tac - #319

Merged
albop merged 1 commit into
masterfrom
fix-timing-docstrings
Aug 6, 2017
Merged

albop merged 1 commit into
masterfrom
fix-timing-docstrings

Conversation

@mmcky

@mmcky mmcky commented Aug 3, 2017

Copy link
Copy Markdown
Contributor

tac and toc docstrings were incorrect.

fixes #314

@mmcky
mmcky requested a review from albop August 3, 2017 06:26
@coveralls

Copy link
Copy Markdown

Coverage Status

Coverage remained the same at 92.124% when pulling 27439cf on fix-timing-docstrings into a82ba69 on master.

@albop

albop commented Aug 6, 2017

Copy link
Copy Markdown
Contributor

The docstring are OK. Looking at these functions again made me think one might sometime want to not print the elapsed time. Could be either toc(verbose=False) or (like in Julia) toq. Does it sound useful ?

@natashawatkins

Copy link
Copy Markdown
Member

I agree - I think there could be some useful improvements to these functions such as suppressing output, adjusting units, choosing precision, etc.

@albop

albop commented Aug 6, 2017

Copy link
Copy Markdown
Contributor

@natashawatkins : do you want to open an issue with the other improvements you can think of ? Then I'll close this PR as it is.

@natashawatkins

Copy link
Copy Markdown
Member

No problem - done in #322

@albop
albop merged commit 64d964c into master Aug 6, 2017

@albop albop left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

OK

@albop

albop commented Aug 6, 2017

Copy link
Copy Markdown
Contributor

@mmcky : I did the merge but can't close the PR. What did you actually expect me to do ?

@natashawatkins

Copy link
Copy Markdown
Member

@albop the PR appears to be closed :)

@albop

albop commented Aug 6, 2017

Copy link
Copy Markdown
Contributor

OK thanks !

@oyamad
oyamad deleted the fix-timing-docstrings branch November 27, 2024 07:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix: Tic/Tac/Toc Utility

4 participants