upstream/ipython Commit - r12246:f8b34083

1

Documenting What's New

1

Documenting What's New

2

----------------------

2

----------------------

3

4

When making a new pull request that either adds a new feature, or makes a

4

When making a new pull request that either adds a new feature, or makes a

5

backwards-incompatible change to IPython, please add a new `.rst` file in this

5

backwards-incompatible change to IPython, please add a new `.rst` file in this

6

directory documenting this change as a part of your Pull Request.

6

directory documenting this change as a part of your Pull Request.

7

8

This will allow multiple Pull Requests to do the same without conflicting with

8

This will allow multiple Pull Requests to do the same without conflicting with

9

one another. Periodically, IPython developers with commit rights will run a

9

one another. Periodically, IPython developers with commit rights will run a

10

script and populate [development.rst](../development.rst)

10

script and populate [development.rst](../development.rst)

11

with the contents of this directory, and clean it up.

11

with the contents of this directory, and clean it up.

12

13

Files which describe new features can have any name, such as

13

Files which describe new features can have any name, such as

14

`antigravity-feature.rst`, whereas backwards incompatible changes ~~should have a~~

14

`antigravity-feature.rst`, whereas backwards incompatible changes **must have**

15

filename starting with `incompat-`, such as ~~`incompat-switching-to-perl.rst`~~.

15

have a filename starting with `incompat-`, such as

16

Our "What's new" files always have two sections, and this prefix scheme will

16

`incompat-switching-to-perl.rst`. Our "What's new" files always have two

17

make sure that the backwards incompatible changes get routed to their proper

17

sections, and this prefix scheme will make sure that the backwards incompatible

18

section.

18

changes get routed to their proper section.

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

             Documenting What's New
             ----------------------
             When making a new pull request that either adds a new feature, or makes a
             backwards-incompatible change to IPython, please add a new `.rst` file in this
             directory documenting this change as a part of your Pull Request.
             This will allow multiple Pull Requests to do the same without conflicting with
             one another. Periodically, IPython developers with commit rights will run a
             script and populate [development.rst](../development.rst)
             with the contents of this directory, and clean it up.
             Files which describe new features can have any name, such as
-            `antigravity-feature.rst`, whereas backwards incompatible changes should have a
+            `antigravity-feature.rst`, whereas backwards incompatible changes **must have**
-            filename starting with `incompat-`, such as `incompat-switching-to-perl.rst`.
+            have a filename starting with `incompat-`, such as
-            Our "What's new" files always have two sections,  and this prefix scheme will
+            `incompat-switching-to-perl.rst`.  Our "What's new" files always have two
-            make sure that the backwards incompatible changes get routed to their proper
+            sections,  and this prefix scheme will make sure that the backwards incompatible
-            section.
+            changes get routed to their proper section.