Skip to content

Commit 6ba32e8

Browse files
committed
DOC : added folders for api_changes and whats_new
Added README + folders for whats_new and api_changes files. The idea is instead of everyone editing the same file (which leads to frequent conflicts requiring either manual merging or re-basing) each entry will create a new file which will be assembled into a single file during the release.
1 parent c04a828 commit 6ba32e8

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

doc/api/api_changes/README.txt

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 a file
2+
in this folder with the name YYYY-MM-DD-[initials].rst (ex 2014-07-31-TAC.rst)
3+
with contents following the form:
4+
5+
Brief destription 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.txt

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
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 see
4+
if you can extend any of them. If you create a name name it `cool_new_feature.rst`
5+
and include contentents of the form:
6+
7+
Section Title for Feature
8+
-------------------------
9+
10+
A bunch of text about how awesome the new feature is and examples of how
11+
to use it.
12+
13+
A sub-section
14+
`````````````

0 commit comments

Comments
 (0)