Re: [sage-devel] Re: Adding doctest

2019-04-24 Thread Bea Galiana
Hi,

Yes, that's what I meant but thank you for making it clearer! It might help
others as well :-)

Best regards.

El mar., 23 abr. 2019 a las 15:53, Simon King ()
escribió:

> Hi Bea,
>
> On 2019-04-23, Bea Galiana  wrote:
> > I've been reading the general conventions about writing tests but I'm not
> > really sure about where should I add it. I did take a look at others
> > scripts where doctests have been added before and it seems I should I
> write
> > it as a comment, so I thought I would just write it as a comment starting
> > with something like this
>
> To avoid a potential confusion: The tests should NOT be in a comment in
> the Python or Cython code, (which would be a line starting with the
> letter "#"). It should be in the docstring of a
> function/method/class/module.
>
> But I guess that's what you mean anyway.
>
> Best regards,
> Simon
>
> --
> 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 sage-devel+unsubscr...@googlegroups.com.
> To post to this group, send email to sage-devel@googlegroups.com.
> Visit this group at https://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 sage-devel+unsubscr...@googlegroups.com.
To post to this group, send email to sage-devel@googlegroups.com.
Visit this group at https://groups.google.com/group/sage-devel.
For more options, visit https://groups.google.com/d/optout.


[sage-devel] Re: Adding doctest

2019-04-23 Thread Simon King
Hi Bea,

On 2019-04-23, Bea Galiana  wrote:
> I've been reading the general conventions about writing tests but I'm not
> really sure about where should I add it. I did take a look at others
> scripts where doctests have been added before and it seems I should I write
> it as a comment, so I thought I would just write it as a comment starting
> with something like this

To avoid a potential confusion: The tests should NOT be in a comment in
the Python or Cython code, (which would be a line starting with the
letter "#"). It should be in the docstring of a function/method/class/module.

But I guess that's what you mean anyway.

Best regards,
Simon

-- 
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 sage-devel+unsubscr...@googlegroups.com.
To post to this group, send email to sage-devel@googlegroups.com.
Visit this group at https://groups.google.com/group/sage-devel.
For more options, visit https://groups.google.com/d/optout.