Skip to content

Commit 811761a

Browse files
committed
DOC : tweaked api_change/whats_new README
- fixed typos - changed txt -> rst so gh will display it nicely (maybe?) - minor prose change to be clearer
1 parent 6ba32e8 commit 811761a

File tree

4 files changed

+25
-23
lines changed

4 files changed

+25
-23
lines changed

doc/api/api_changes/README.rst

Lines changed: 9 additions & 0 deletions
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/api/api_changes/README.txt

Lines changed: 0 additions & 9 deletions
This file was deleted.

doc/users/whats_new/README.rst

Lines changed: 16 additions & 0 deletions
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+
`````````````

doc/users/whats_new/README.txt

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)