@@ -373,11 +373,10 @@ module being documented. Each module should be documented in its own file.
373373Normally this markup appears after the title heading of that file; a typical
374374file might start like this::
375375
376- :mod:`parrot` -- Dead parrot access
377- ===================================
376+ :mod:`! parrot` -- Dead parrot access
377+ ====================================
378378
379379 .. module:: parrot
380- :platform: Unix, Windows
381380 :synopsis: Analyze and reanimate dead parrots.
382381 .. moduleauthor:: Eric Cleese <eric@python.invalid>
383382 .. moduleauthor:: John Idle <john@python.invalid>
@@ -391,12 +390,6 @@ As you can see, the module-specific markup consists of two directives, the
391390 or submodule. The name should be fully qualified (that is, including the
392391 package name for submodules).
393392
394- The ``platform `` option, if present, is a comma-separated list of the
395- platforms on which the module is available (if it is available on all
396- platforms, the option should be omitted). The keys are short identifiers;
397- examples that are in use include "IRIX", "Mac", "Windows", and "Unix". It is
398- important to use a key which has already been used when applicable.
399-
400393 The ``synopsis `` option should consist of one sentence describing the
401394 module's purpose -- it is currently only used in the Global Module Index.
402395
0 commit comments