From 6ba32e89b20cf1fe7995c289ce5ceb89a68d862f Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Thu, 31 Jul 2014 17:15:43 -0400 Subject: [PATCH 1/2] 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. --- doc/api/api_changes/README.txt | 9 +++++++++ doc/users/whats_new/README.txt | 14 ++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 doc/api/api_changes/README.txt create mode 100644 doc/users/whats_new/README.txt diff --git a/doc/api/api_changes/README.txt b/doc/api/api_changes/README.txt new file mode 100644 index 000000000000..199ce793cfc6 --- /dev/null +++ b/doc/api/api_changes/README.txt @@ -0,0 +1,9 @@ +For changes which require an entry in `api_changes.rst` please create a file +in this folder with the name YYYY-MM-DD-[initials].rst (ex 2014-07-31-TAC.rst) +with contents following the form: + +Brief destription of change +``````````````````````````` + +Long description of change, justification, and work-arounds to +maintain old behavior (if any). diff --git a/doc/users/whats_new/README.txt b/doc/users/whats_new/README.txt new file mode 100644 index 000000000000..dc0ea62eb26c --- /dev/null +++ b/doc/users/whats_new/README.txt @@ -0,0 +1,14 @@ +This folder is for placing new portions of `whats_new.rst`. + +When adding an entry please look at the currently existing files to see +if you can extend any of them. If you create a name name it `cool_new_feature.rst` +and include contentents of the form: + +Section Title for Feature +------------------------- + +A bunch of text about how awesome the new feature is and examples of how +to use it. + +A sub-section +````````````` From 811761a28d22cab55ce5c8716972b54339403d81 Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Fri, 8 Aug 2014 10:33:31 -0400 Subject: [PATCH 2/2] 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 --- doc/api/api_changes/README.rst | 9 +++++++++ doc/api/api_changes/README.txt | 9 --------- doc/users/whats_new/README.rst | 16 ++++++++++++++++ doc/users/whats_new/README.txt | 14 -------------- 4 files changed, 25 insertions(+), 23 deletions(-) create mode 100644 doc/api/api_changes/README.rst delete mode 100644 doc/api/api_changes/README.txt create mode 100644 doc/users/whats_new/README.rst delete mode 100644 doc/users/whats_new/README.txt diff --git a/doc/api/api_changes/README.rst b/doc/api/api_changes/README.rst new file mode 100644 index 000000000000..f317cab10d41 --- /dev/null +++ b/doc/api/api_changes/README.rst @@ -0,0 +1,9 @@ +For changes which require an entry in `api_changes.rst` please create +a file in this folder with the name :file:`YYYY-MM-DD-[initials].rst` +(ex :file:`2014-07-31-TAC.rst`) with contents following the form: :: + + Brief description of change + ``````````````````````````` + + Long description of change, justification, and work-arounds to + maintain old behavior (if any). diff --git a/doc/api/api_changes/README.txt b/doc/api/api_changes/README.txt deleted file mode 100644 index 199ce793cfc6..000000000000 --- a/doc/api/api_changes/README.txt +++ /dev/null @@ -1,9 +0,0 @@ -For changes which require an entry in `api_changes.rst` please create a file -in this folder with the name YYYY-MM-DD-[initials].rst (ex 2014-07-31-TAC.rst) -with contents following the form: - -Brief destription of change -``````````````````````````` - -Long description of change, justification, and work-arounds to -maintain old behavior (if any). diff --git a/doc/users/whats_new/README.rst b/doc/users/whats_new/README.rst new file mode 100644 index 000000000000..dd8e4a8a5214 --- /dev/null +++ b/doc/users/whats_new/README.rst @@ -0,0 +1,16 @@ +This folder is for placing new portions of `whats_new.rst`. + +When adding an entry please look at the currently existing files to +see if you can extend any of them. If you create a file, name it +something like :file:`cool_new_feature.rst` if you have added a brand new +feature or something like :file:`updated_feature.rst` for extensions of +existing features. Include contents of the form: :: + + Section Title for Feature + ------------------------- + + A bunch of text about how awesome the new feature is and examples of how + to use it. + + A sub-section + ````````````` diff --git a/doc/users/whats_new/README.txt b/doc/users/whats_new/README.txt deleted file mode 100644 index dc0ea62eb26c..000000000000 --- a/doc/users/whats_new/README.txt +++ /dev/null @@ -1,14 +0,0 @@ -This folder is for placing new portions of `whats_new.rst`. - -When adding an entry please look at the currently existing files to see -if you can extend any of them. If you create a name name it `cool_new_feature.rst` -and include contentents of the form: - -Section Title for Feature -------------------------- - -A bunch of text about how awesome the new feature is and examples of how -to use it. - -A sub-section -`````````````