> > 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. 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 think, to make a docstring less cluttered, double quotes should be used only to refer to arguments as in "INPUT: - ``algorithm`` -- ..." and obviously code fragments. This convention also would make easier to discern arguments in docstrings. -- 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.
