sandbox/enhancement-proposals/dep-NNN.txt

   1 ==================================
   2 :Title: <REQUIRED: proposal title>
   3 ==================================
   4
   5 :Author: <REQUIRED: list of authors' real names and optionally, email addrs>
   6 :Discussions-To: docutils-develop@lists.sf.net, <enhancement ticket URL>
   7 :Status: <REQUIRED: Draft | Active | Accepted | Provisional | Deferred | Rejected | Withdrawn | Final | Superseded>
   8 :Type: <REQUIRED: API | Informational | Process>
   9 :Created: <date created on, in dd-mmm-yyyy format>
  10 :Docutils-Version: <version number>
  11 :Replaces: current policy/API document
  12 :Resolution: <url>
  13
  14
  15 Abstract
  16 ========
  17
  18 .. A short (<~200 word) description of the technical issue being addressed.
  19
  20
  21 Motivation
  22 ==========
  23
  24 .. Clearly explain why the existing specification is inadequate to
  25    address the problem that the proposal solves.
  26
  27
  28 Rationale
  29 =========
  30
  31 .. Describe why particular design decisions were made.
  32
  33
  34 Specification
  35 =============
  36
  37 .. Describe the syntax and semantics of any new feature.
  38
  39
  40 Backwards Compatibility
  41 =======================
  42
  43 .. Describe potential impact and severity on pre-existing code.
  44
  45
  46 Security Implications
  47 =====================
  48
  49 .. How could a malicious user take advantage of this new feature?
  50
  51
  52 How to Teach This
  53 =================
  54
  55 .. How to teach users, new and experienced, how to apply the proposal to
  56    their work.
  57
  58
  59 Reference Implementation
  60 ========================
  61
  62 .. Link to any existing implementation and details about its state, e.g.
  63    proof-of-concept.
  64
  65
  66 Rejected Ideas
  67 ==============
  68
  69 .. Why certain ideas that were brought while discussing this proposal
  70    were not ultimately pursued.
  71
  72
  73 Open Issues
  74 ===========
  75
  76 .. Any points that are still being decided/discussed.
  77
  78
  79 References
  80 ==========
  81
  82 .. A collection of URLs used as references through the proposal.
  83
  84
  85 Copyright
  86 =========
  87
  88 This document is placed in the public domain or under the
  89 CC0-1.0-Universal license, whichever is more permissive.
  90
  91
  92 \f
  93 ..
  94     Local Variables:
  95     mode: indented-text
  96     indent-tabs-mode: nil
  97     sentence-end-double-space: t
  98     fill-column: 70
  99     coding: utf-8
 100     End: