I think that having an optional Sphinx block is a good idea. Perhaps it could be colored differently in the html documentation (like WARNING blocks are)? When printing on the command line, I think we're just used to the #optional tag. It's unclear to me whether the #optional tag or an OPTIONAL block is more confusing/more likely to be missed for a new user.
I agree with Volker and Jeroen that a module level optional tag is not a good idea, since it's not localized. David On Wed, Apr 13, 2016 at 5:58 PM, Simon King <simon.k...@uni-koeln.de> wrote: > > Am Mittwoch, 13. April 2016 19:22:12 UTC+2 schrieb Volker Braun: >> >> Or just call the block OPTIONAL, so that >> >> EXAMPLES:: >> >> sage: bar() # optional - foo >> sage: baz() # optional - foo >> >> is equivalent to >> >> OPTIONAL - foo:: >> >> sage: bar() >> sage: baz() >> > > I like that proposal. > > -- > 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. > -- 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.
