-
Notifications
You must be signed in to change notification settings - Fork 949
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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 |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
name: Documentation improvement | ||
about: Create a report to help us improve the documentation | ||
labels: doc | ||
--- | ||
|
||
<!--To help us understand and resolve your issue, please fill out the form to the best of your ability.--> | ||
<!--You can feel free to delete the sections that do not apply.--> | ||
|
||
### Problem | ||
|
||
<!-- | ||
If you are referencing an existing piece of documentation or example please provide a link. | ||
* I found [...] to be unclear because [...] | ||
* [...] made me think that [...] when really it should be [...] | ||
* There is no example showing how to do [...] | ||
--> | ||
|
||
|
||
### Suggested Improvement | ||
|
||
<!-- | ||
If you have an idea to improve the documentation please suggest it here | ||
* This line should be be changed to say [...] | ||
* Include a paragraph explaining [...] | ||
* Add a figure showing [...] | ||
--> |