Author terry.reedy
Recipients docs@python, eric.araujo, ezio.melotti, jdemeyer, mdk, steven.daprano, terry.reedy, willingc
Date 2019-05-16.15:25:40
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1558020340.44.0.907247727413.issue36675@roundup.psfhosted.org>
In-reply-to
Content
Doctest directives in code examples should be suppressed everywhere *except* in the doctest.html examples showing how to use directives.  The patch only exposes them for doctest.html and not for ctypes or anywhere else.

They really should not be in the dir example code that I linked to.
https://docs.python.org/3/library/functions.html#dir
The problem there are the double comments with both a real comment and a directive.

https://devguide.python.org/documenting/#source-code does not say anything about '::' causing suppression of comments and ':' leaving them.  It is misleading in implying the '::' is required for a code block.
History
Date User Action Args
2019-05-16 15:25:40terry.reedysetrecipients: + terry.reedy, ezio.melotti, eric.araujo, steven.daprano, docs@python, jdemeyer, willingc, mdk
2019-05-16 15:25:40terry.reedysetmessageid: <1558020340.44.0.907247727413.issue36675@roundup.psfhosted.org>
2019-05-16 15:25:40terry.reedylinkissue36675 messages
2019-05-16 15:25:40terry.reedycreate