Skip to content

Commit 18f199f

Browse files
committed
documentation issue template
1 parent 28fe789 commit 18f199f

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Documentation improvement
3+
about: Create a report to help us improve the documentation
4+
labels: Documentation
5+
# This template is based on the matplotlib template
6+
---
7+
8+
### Problem
9+
10+
<!--
11+
If you are referencing an existing piece of documentation or example please provide a link.
12+
13+
* I found [...] to be unclear because [...]
14+
* [...] made me think that [...] when really it should be [...]
15+
* There is no example showing how to do [...]
16+
-->
17+
18+
19+
### Suggested Improvement
20+
21+
<!--
22+
If you have an idea to improve the documentation please suggest it here
23+
24+
* This line should be changed to say [...]
25+
* Include a paragraph explaining [...]
26+
* Add a figure showing [...]
27+
-->

0 commit comments

Comments
 (0)