File: ep-template.rst

package info (click to toggle)
python-docutils 0.22%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 11,448 kB
  • sloc: python: 53,302; lisp: 14,475; xml: 1,807; javascript: 1,032; makefile: 102; sh: 96
file content (97 lines) | stat: -rw-r--r-- 2,135 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
.. include:: header.rst

==========================
<EP number> — <title>
==========================

:Author:  <name and optional e-mail; use ``:Authors:`` for a list>
:Discussions-To: <current discussion thread and/or enhancement ticket URL>
:Status:  <Draft | Active | Accepted | Provisional | Deferred |
          Rejected | Withdrawn | Final | Superseded>
:Created: <yyyy-mm-dd>

  .. optional
:Docutils-Version: <first release including the new feature>
:Post-History: <past discussion threads and/or issue tickets>
:Type:    <Standard (default) | Informational | Process>
:Topic:   <API | reStructuredText | DocTree | HTML output | ...>
:Requires: <EP number(s)>
:Replaces: <current EP, policy or API document>
:Superseded-By: <EP number>
:Resolution: <`yyyy-mm-dd <link to decision>`__>

:Abstract:
  .. A short (<~200 word) description of the technical issue being addressed.

.. contents::


Motivation
==========

.. Clearly explain why the existing specification is inadequate to
   address the problem that the proposal solves.


Rationale
=========

.. Describe why particular design decisions were made.


Specification
=============

.. Describe the syntax and semantics of any new feature.


Backwards Compatibility
=======================

.. Describe potential impact and severity on pre-existing code.


Security Implications
=====================

.. How could a malicious user take advantage of this new feature?


How to Teach This
=================

.. How to teach users, new and experienced, how to apply the proposal to
   their work.


Reference Implementation
========================

.. Link to any existing implementation and details about its state, e.g.
   proof-of-concept.


Rejected Ideas
==============

.. Why certain ideas that were brought while discussing this proposal
   were not ultimately pursued.


Open Issues
===========

.. Any points that are still being decided/discussed.


References
==========

.. A collection of footnotes and references.


Copyright
=========

This document is placed in the public domain or under the
CC0-1.0-Universal license, whichever is more permissive.