Skip to content

Commit fb27b4c

Browse files
committed
Merge pull request matplotlib#3349 from tacaswell/api_whats_new_folders
DOC : added folders for api_changes and whats_new
2 parents b1ebb3c + 811761a commit fb27b4c

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

doc/api/api_changes/README.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
For changes which require an entry in `api_changes.rst` please create
2+
a file in this folder with the name :file:`YYYY-MM-DD-[initials].rst`
3+
(ex :file:`2014-07-31-TAC.rst`) with contents following the form: ::
4+
5+
Brief description of change
6+
```````````````````````````
7+
8+
Long description of change, justification, and work-arounds to
9+
maintain old behavior (if any).

doc/users/whats_new/README.rst

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
This folder is for placing new portions of `whats_new.rst`.
2+
3+
When adding an entry please look at the currently existing files to
4+
see if you can extend any of them. If you create a file, name it
5+
something like :file:`cool_new_feature.rst` if you have added a brand new
6+
feature or something like :file:`updated_feature.rst` for extensions of
7+
existing features. Include contents of the form: ::
8+
9+
Section Title for Feature
10+
-------------------------
11+
12+
A bunch of text about how awesome the new feature is and examples of how
13+
to use it.
14+
15+
A sub-section
16+
`````````````

0 commit comments

Comments
 (0)