Arggggg... Sorry I misread. I have to live with half a brain these days.

I'm +1 to the change 'not tested' -> 'skip' for the reason that you
gave in your first message.

I'm not too keen on adding 'doctest:' everywhere though. Some of us
type these things often.

Nathann

On 29 October 2015 at 13:51, Vincent Delecroix
<[email protected]> wrote:
> On 29/10/15 09:23, Samuel Lelièvre wrote:
>>
>> When consulting the documentation, many code fragments
>> have annotations that are meant as doctesting instructions.
>>
>> Among these doctesting instructions, there is one, "# not tested",
>> that tells the doctesting mechanism to skip that line in doctests.
>>
>> However, to the non-expert eye, such as a non-developer user
>> reading the documentation, seeing "# not tested" produces the
>> impression that this piece of code is not guaranteed to work,
>> because it has never been tested.
>>
>> I would like to make a suggestion to make the comments more
>> explicit, by replacing them as follows:
>>
>> -     # not tested
>> +     # doctest: skip
>>
>> -     # not tested (random order)
>> +     # doctest: skip (random order)
>>
>> -     # optional - qepcad
>> +     # doctest: optional - qepcad
>
>
> Though, randomness problem *should* be tested... we currently have a keyword
>
>  # random
>
> that does execute the code but does not try to match the result with what is
> written in the doctest. Following your suggestion this would become
>
> -     # random
> +     # doctest: random
>
> Vincent
>
>
> --
> You received this message because you are subscribed to a topic in the
> Google Groups "sage-devel" group.
> To unsubscribe from this topic, visit
> https://groups.google.com/d/topic/sage-devel/wH2JiJcA-8M/unsubscribe.
> To unsubscribe from this group and all its topics, send an email to
> [email protected].
> To post to this group, send email to [email protected].
> Visit this group at http://groups.google.com/group/sage-devel.
> For more options, visit https://groups.google.com/d/optout.

-- 
You received this message because you are subscribed to the Google Groups 
"sage-devel" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-devel.
For more options, visit https://groups.google.com/d/optout.

Reply via email to