On 3 April 2015 at 12:36, Nathann Cohen <nathann.co...@gmail.com> wrote:
>> states an optional SEEALSO block for links to other functions, methods,
>> modules, etc. On step in more links could be to encourage people to use
>> this block more frequently (see http://trac.sagemath.org/ticket/18120).
>>
>> What do you think about this topic? How can we make our documentation
>> linked better together?
>
>
> To be more accurate, the ticket at 18120 removes the 'optional' mention next
> to the 'SEEALSO' section, thus implying that it is mandatory for all
> functions to have a 'SEEALSO' section.

Being mandatory seems to me to be going too far, and my instinct tells
me that removing "optional" and replacing with "strongly recommended
wherever appropriate" would be more productive than making it
literally mandatory for all functions, as Nathann suggests.

John

>
> Nathann
>
> --
> 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 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 sage-devel+unsubscr...@googlegroups.com.
To post to this group, send email to sage-devel@googlegroups.com.
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