[Python-checkins] cpython: time.steady() doc: don't repeat the default value

[Eric V. Smith]

On 03/19/2012 08:17 AM, victor.stinner wrote:
> http://hg.python.org/cpython/rev/0741add59487
> changeset:   75836:0741add59487
> user:        Victor Stinner <vstinner at wyplay.com>
> date:        Mon Mar 19 13:17:24 2012 +0100
> summary:
>   time.steady() doc: don't repeat the default value
> 
> files:
>   Doc/library/time.rst |  2 +-
>   1 files changed, 1 insertions(+), 1 deletions(-)
> 
> 
> diff --git a/Doc/library/time.rst b/Doc/library/time.rst
> --- a/Doc/library/time.rst
> +++ b/Doc/library/time.rst
> @@ -236,7 +236,7 @@
>     adjusted. The reference point of the returned value is undefined so only the
>     difference of consecutive calls is valid.
>  
> -   If available, a monotonic clock is used. By default, if *strict* is False,
> +   If available, a monotonic clock is used. By default,
>     the function falls back to another clock if the monotonic clock failed or is
>     not available. If *strict* is True, raise an :exc:`OSError` on error or
>     :exc:`NotImplementedError` if no monotonic clock is available.

I still think this is not a great phrasing. Why use "by default",
instead of "if strict is False"?

My concern is that to me "time.steady(False)" doesn't appear to be using
any default value, yet the "By default" part of the sentence applies.

Eric.