Changes between Initial Version and Version 1 of Ticket #20264, comment 37


Ignore:
Timestamp:
10/13/19 07:27:05 (8 months ago)
Author:
chapoton
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Ticket #20264, comment 37

    initial v1  
    44which I disagree with
    55
    6  
     6ok. That would be slightly faster.
     7
    78> * Is there some reference article, either as preprint or published ? If yes, should be added.
    89
    910as the answer is yes, and I need to figure out how to add the reference properly.
    1011
     12The reference itself should be added in the master reference file:
     13
     14src/doc/en/reference/references/index.rst
     15
     16and called in your files somewhere using the usual syntax {{{[Who2019]_ }}}
     17
    1118* long tests
    1219How do we determine what is long?
    1320
     21using
     22{{{
     23./sage -bt --long --warn-long src/sage/schemes/cyclic_covers/
     24}}}
     25
     26Well, your machine may be too quick. Mine is slow. I will launch this command and report.
    1427
    1528I also have an honest question, do you know the reason for not using the 3rd person in the documentation, e.g., return instead of returns? I know it is pep8 stuff, but I am confused about how should I be reading docstrings for this to make sense grammatically, as I always read them as the function F does something...
    1629
    17 Cheers,
    18 Edgar
     30This is not pep8 stuff, but sage's own decision. The first line of the documentation is supposed to be in imperative mode (like when giving an order) as explained here:
    1931
     32http://doc.sagemath.org/html/en/developer/coding_basics.html#documentation-strings
     33