DOC : whole bunch of documentation clean up #3170
DOC : tweaked FAQ about new features
- Loading branch information
commit d11fc1aede5e4641d48bbfd5ccc741d1a893d85f
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
|
|
||
| .. _howto-faq: | ||
|
|
||
| ****** | ||
|
|
@@ -489,22 +490,31 @@ The development of matplotlib is organized through `github | |
| <https://github.com/matplotlib/matplotlib>`_. If you would like | ||
| to report a bug or submit a patch please use that interface. | ||
|
|
||
| To report a bug just `create an issue | ||
| <https://github.com/matplotlib/matplotlib/issues/new>`_ on github. | ||
| Please include a `Short, Self Contained, Correct (Compilable), Example | ||
| <http://sscce.org>`_ demonstrating what is wrong. This makes it much | ||
| easier for the developers to evaluate the bug report and gives them a | ||
| start on where to start looking for the bug. The easier it is for the | ||
| developers to understand your problem the faster it will get fixed. | ||
| Expect that the bug reports will be a conversation. If you do not | ||
| want to register with github, please email bug reports to the `mailing | ||
| list <[email protected]>`_. | ||
|
|
||
|
|
||
| The easiest way to submit patches to matplotlib is through pull | ||
| requests on github. Please see the :ref:`developers-guide-index` for | ||
| the details. | ||
|
|
||
| .. _how-to-request-feature: | ||
|
|
||
| Request a new feature | ||
| --------------------- | ||
|
|
||
| Is there a feature you wish matplotlib had? Then ask! The best | ||
|
There was a problem hiding this comment. Comment that this is an open source project, and that there is no way that we can guarantee that it will get done... There was a problem hiding this comment. This has been dealt with, just not in a way that triggered the auto-hide logic. |
||
| way to get started is to email the developer `mailing | ||
| list <[email protected]>`_ for discussion. | ||
|
|
||
|
|
||
| .. _how-to-contribute-docs: | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is that sentence grammatically correct?