On Apr 26, 2:17 am, Keshav Kini wrote:
> In general I think it might be useful to have a "sage-lint" script to find
> and highlight weird or probably weird stuff in the codebase. This could
> subsume both your suggested script and the coverage script, as well as
> perhaps look for python 2.x ->
This is also basic, but inconsistent throughout the documentation.
The first one line of every method docstring should be written as a command.
Hence
"""
Return true if blah blah
rather than
"""
Returns true if blah blah
Kwankyu
--
To post to this group, send an email to sage-devel@googleg
On Apr 25, 8:04 am, "Nicolas M. Thiery"
wrote:
> On Sat, Apr 23, 2011 at 08:45:06AM -0700, kcrisman wrote:
> On the other hand, there is no point in adding a sentence like "We
> here give an interesting example", as it does not bring any
> information:
It may be useful, in case the other examp
In general I think it might be useful to have a "sage-lint" script to find
and highlight weird or probably weird stuff in the codebase. This could
subsume both your suggested script and the coverage script, as well as
perhaps look for python 2.x -> 3.x issues, internal usage of deprecated
funct
On Apr 25, 8:04 am, "Nicolas M. Thiery"
wrote:
> On Sat, Apr 23, 2011 at 08:45:06AM -0700, kcrisman wrote:
> > And it should be
>
> > EXAMPLES:
>
> > We here give an interesting example::
>
> > sage: bla
>
> +1 on the S to EXAMPLES. And, when not obvious, +1 on having a
> descrip
On Sat, Apr 23, 2011 at 08:45:06AM -0700, kcrisman wrote:
> And it should be
>
> EXAMPLES:
>
> We here give an interesting example::
>
> sage: bla
+1 on the S to EXAMPLES. And, when not obvious, +1 on having a
description of the intention of the example is doing.
On the other
Hi David,
On 24 Apr., 11:19, "Dr. David Kirkby" wrote:
> Is there a way of forcing Sphinx to reject these, so we find them? A C
> compiler
> should not allow one to compile code that has syntax errors, so why should
> Sphinx?
Sphinx does produce warnings. But sometimes I get the impression tha
On Sunday, 24 April 2011 13:03:13 UTC+8, robertwb wrote:
> We really need to find a way to
> speed this up, parallelizing it an otherwise.
+1. Sphinx is really slow. It seems (naively) that parallelization would
effect great speedups, but would it also be possible to Cythonize it in some
way? Wo
On Sat, Apr 23, 2011 at 8:45 AM, kcrisman wrote:
>
>
> On Apr 23, 9:56 am, Florent Hivert
> wrote:
>> Hi Simon,
>>
>> > There is another quite common mistake:
>>
>> > It should be
>> > EXAMPLE::
>>
>> > sage: bla
>>
>> > and not
>>
>> > EXAMPLE:
>> > sage: bla
>>
>
>
On Apr 23, 9:56 am, Florent Hivert
wrote:
> Hi Simon,
>
> > There is another quite common mistake:
>
> > It should be
> > EXAMPLE::
>
> > sage: bla
>
> > and not
>
> > EXAMPLE:
> > sage: bla
>
And it should be
EXAMPLES:
We here give an interesting examp
Hi Florent,
On 23 Apr., 15:56, Florent Hivert
wrote:
> Sure ! I thought this one was too basic...
You can find it quite often, my impression.
Isn't there a skript to find common markup errors? If not, it would
seem useful to write one.
> Thanks !!! To avoid endless problem with rebasing sage-c
Hi Simon,
> There is another quite common mistake:
>
> It should be
> EXAMPLE::
>
> sage: bla
>
> and not
>
> EXAMPLE:
> sage: bla
Sure ! I thought this one was too basic...
> Just to avoid duplication of work: We killed a bunch of those mistakes
> in #9976.
Th
Hi Florent,
On 23 Apr., 15:27, Florent Hivert
wrote:
> Now here is a random and non exhaustive lists of common mistakes:
>
> 1 - Do NOT indent bullet lists (unless you want extra indentation) and leave a
> blank line at the end as
> """
> INPUT:
>
> - ``self`` -- bla bla
> - ``opts`` -- .
13 matches
Mail list logo
