On 2017-05-17 13:40, Kwankyu Lee wrote: > I am simply asking why we aren't writing a docstring as > > "Return True if ...." > > instead of > > "Return ``True`` if ..." > > just like > > "Return an integer ..." > > instead of > > "Return an ``Integer``"
Because ``True`` is an object of type bool which is represented by the printed string "True". Thus the comparison should be with "Return a boolean" would be more appropriate. Moreover, a capitalized True looks somehow weird; shouln't it be "Return true if..." then? As mentioned in the other thread, the best would probably be to link True to its Python-docmentation [T], which is possible in SageMath. E.g., for RuntimeException, I would use :python:`RuntimeError<library/exceptions.html#exceptions.RuntimeError>` See [R] for a live view. The same should be possible for True/False/None. In this way we would not lose some structure; even gain more cross-links, which is good. [T] https://docs.python.org/3/library/constants.html#True [R] http://doc.sagemath.org/html/en/reference/asymptotic/sage/rings/asymptotic/asymptotic_ring.html#sage.rings.asymptotic.asymptotic_ring.NoConvergenceError -- 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.
