← Back to branch summary

~ubuntu-branches/ubuntu/lucid/python2.6/lucid

« back to all changes in this revision

Viewing changes to Doc/documenting/markup.rst

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2010-03-11 13:30:19 UTC
  • mto: (10.1.13 sid)
  • mto: This revision was merged to the branch mainline in revision 44.
  • Revision ID: james.westby@ubuntu.com-20100311133019-sblbooa3uqrkoe70
Tags: upstream-2.6.5~rc2
Import upstream version 2.6.5~rc2

Show diffs side-by-side

added added

removed removed

Lines of Context:
Doc/documenting/markup.rst
597
597
   An important bit of information about an API that a user should be aware of
598
598
   when using whatever bit of API the warning pertains to.  The content of the
599
599
   directive should be written in complete sentences and include all appropriate
600
 
   punctuation.  This should only be chosen over ``note`` for information
601
 
   regarding the possibility of crashes, data loss, or security implications.
 
600
   punctuation.  In the interest of not scaring users away from pages filled
 
601
   with warnings, this directive should only be chosen over ``note`` for
 
602
   information regarding the possibility of crashes, data loss, or security
 
603
   implications.
602
604
 
603
605
.. describe:: versionadded
604
606
 
624
626
 
625
627
--------------
626
628
 
 
629
.. describe:: impl-detail
 
630
 
 
631
   This directive is used to mark CPython-specific information.  Use either with
 
632
   a block content or a single sentence as an argument, i.e. either ::
 
633
 
 
634
      .. impl-detail::
 
635
 
 
636
         This describes some implementation detail.
 
637
 
 
638
         More explanation.
 
639
 
 
640
   or ::
 
641
 
 
642
      .. impl-detail:: This shortly mentions an implementation detail.
 
643
 
 
644
   "\ **CPython implementation detail:**\ " is automatically prepended to the
 
645
   content.
 
646
 
627
647
.. describe:: seealso
628
648
 
629
649
   Many sections include a list of references to module documentation or