On Thu, 1 Oct 2015, Eric Gourgoulhon wrote:
2) What about `self` in docstrings?
There was a discussion about this some time ago
https://groups.google.com/d/msg/sage-devel/58RUzV32vI0/rf4Mldr60JkJ
A compromise would be to avoid ``self`` in the docstrings of public methods
(the only ones rea
Le lundi 28 septembre 2015 08:46:12 UTC+2, Jori Mäntysalo a écrit :
>
> On Fri, 25 Sep 2015, Travis Scrimshaw wrote:
>
> >>> 2) What about `self` in docstrings?
>
> >> There was a discussion about this some time ago:
> >> https://groups.google.com/d/msg/sage-devel/58RUzV32vI0/rf4Mldr60JkJ
> >
On Fri, 25 Sep 2015, Travis Scrimshaw wrote:
2) What about `self` in docstrings?
There was a discussion about this some time ago:
https://groups.google.com/d/msg/sage-devel/58RUzV32vI0/rf4Mldr60JkJ
and the conclusion was that we should avoid to use ``self`` in the
documentation.
That was n
On Sun, Sep 27, 2015 at 11:39 PM, Jori Mäntysalo wrote:
> On Fri, 25 Sep 2015, William Stein wrote:
>
1) Should we include symbols in docstrings? I.e. add \otimes to
ordinal_product() of posets, as used in Enumerative combinatorics?
>
>
>>> IMHO, yes. They are nicely rendered in the html
On Fri, 25 Sep 2015, William Stein wrote:
1) Should we include symbols in docstrings? I.e. add \otimes to
ordinal_product() of posets, as used in Enumerative combinatorics?
IMHO, yes. They are nicely rendered in the html documentation, either
in the notebook or in the reference manual pages.
On Fri, Sep 25, 2015 at 9:33 AM, Eric Gourgoulhon
wrote:
>
>
> Le vendredi 25 septembre 2015 16:47:23 UTC+2, William a écrit :
>>
>>
>> > we may assume that most users understand LaTeX.
>>
>> This is a questionable assumption. Numerical most users of Sage are
>> undergraduates, and most undergrad
Le vendredi 25 septembre 2015 16:47:23 UTC+2, William a écrit :
>
>
> > we may assume that most users understand LaTeX.
>
> This is a questionable assumption. Numerical most users of Sage are
> undergraduates, and most undergraduates don't know about LaTeX.
>
>
Yes you are right!
The mission
Hi all,
Slightly off-topic, but before deciding whether we use LaTeX or not, it
would be nice to document how to use latex/tt font in the doc.
Each time I happen to write some doc I cannot remember what backquotes and
double backquotes do and you have to look deep inside the rest/sphinx doc
to
> More on docstrings:
>>
>> "The Frattini sublattice `\Phi(L)` is the intersection - -" vs. "Returns
>> the Frattini subgroup of ``self``. The Frattini - -".
>>
>> 1) Should we include symbols in docstrings? I.e. add \otimes to
>> ordinal_product() of posets, as used in Enumerative combinator
On Friday, September 25, 2015 at 7:47:23 AM UTC-7, William wrote:
>
> On Fri, Sep 25, 2015 at 4:38 AM, Eric Gourgoulhon
> > wrote:
> > Hi,
> >
> > Le vendredi 25 septembre 2015 08:45:34 UTC+2, Jori Mäntysalo a écrit :
> >>
> >> More on docstrings:
> >>
> >> "The Frattini sublattice `\Phi(
On Fri, Sep 25, 2015 at 4:38 AM, Eric Gourgoulhon
wrote:
> Hi,
>
> Le vendredi 25 septembre 2015 08:45:34 UTC+2, Jori Mäntysalo a écrit :
>>
>> More on docstrings:
>>
>> "The Frattini sublattice `\Phi(L)` is the intersection - -" vs. "Returns
>> the Frattini subgroup of ``self``. The Frattini - -"
Hi,
Le vendredi 25 septembre 2015 08:45:34 UTC+2, Jori Mäntysalo a écrit :
>
> More on docstrings:
>
> "The Frattini sublattice `\Phi(L)` is the intersection - -" vs. "Returns
> the Frattini subgroup of ``self``. The Frattini - -".
>
> 1) Should we include symbols in docstrings? I.e. add \otime
12 matches
Mail list logo
