Skip to content

DOC : added folders for api_changes and whats_new #3349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 17, 2014
Merged

DOC : added folders for api_changes and whats_new #3349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ba32e8
DOC : added folders for api_changes and whats_new
tacaswell Jul 31, 2014
811761a
DOC : tweaked api_change/whats_new README
tacaswell Aug 8, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/api/api_changes/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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).
16 changes: 16 additions & 0 deletions doc/users/whats_new/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
`````````````