On 2017-05-17 10:51, Kwankyu Lee wrote: > I am for writing double-quotes ``True``, ``False``, ``None``, as > this is > the "offical" representation of these objects and therefore is printed > as output. Thus a typewriter-font is appropriate. > > > In what sense, is it official? In Python or in Sage? > > Two reasons why I am against it: > > 1. Objects in Sage are written in plain English. Thus a method returns, > say, an integer not an "Integer" or an element not an "Element". We can > regard True, False, and None as just proper names of Python objects. The > docstrings should be written in plain English as much as possible. > Double-quotes are redundant.
Maybe I misunderstood your double-quotes. I meant ``True`` (and talk about these double-quotes; this will be typeset with a typewriter font). These double-quotes are not shown in the formatted text, only in the source. In contrast, it should not be "True" or ``"True"``. > 2. True, False, None are very frequent in docstrings as arguments and > return values. They look better without double-quotes if you see them > via help(...) or ? in terminal or in jupyter. We should consider how a > docstring look in terminal, jupyter, as pdf, and as a webpage, and we > should make a balance. I agree; in the formatteed text, there should not be quotes, but it should also not be formatted as plain text. See, for example https://docs.python.org/3/library/constants.html where there is Assignments to ``True`` are... Best, Daniel -- 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 [email protected]. To post to this group, send email to [email protected]. Visit this group at https://groups.google.com/group/sage-devel. For more options, visit https://groups.google.com/d/optout.
