File tree Expand file tree Collapse file tree 1 file changed +7
-5
lines changed Expand file tree Collapse file tree 1 file changed +7
-5
lines changed Original file line number Diff line number Diff line change @@ -174,10 +174,10 @@ questions:
174
174
multiple : true
175
175
other : true
176
176
choices :
177
- - " Google format (indented sections)"
177
+ - " Google format (my_param (type): description)"
178
+ - " Numpydoc format (my_param : type \n description indented on new line)"
179
+ - " Sphinx format (:param [my_param]: description)"
178
180
- " Markdown"
179
- - " Numpydoc format (underlined sections)"
180
- - " Sphinx format (reStructuredText)"
181
181
- " I don’t know"
182
182
183
183
# Motivation: Reflect on priorities for documentation in general.
@@ -268,7 +268,7 @@ questions:
268
268
- " Sphinx Book"
269
269
- " Sphinx Bootstrap"
270
270
- " Sphinx Immaterial"
271
- - " Something else/ I don’t know"
271
+ - " I don’t know"
272
272
273
273
# Motivation: Explore patterns in Sphinx output priorities. This might be useful for contextualizing other answers.
274
274
- title : " In which formats do you publish your documentation with sphinx?"
@@ -297,7 +297,9 @@ questions:
297
297
- " No native support for Markdown"
298
298
- " Performance issues"
299
299
- " reStructuredText syntax is too complicated"
300
- - " Sphinx breaks too often"
300
+ - " usability issues, e.g. unclear error messages"
301
+ - " Insufficient documentation"
302
+ - " Sphinx breaks too often on new releases"
301
303
- " Sphinx is missing features I want"
302
304
303
305
# Motivation: Explore patterns in what people using Sphinx struggle with.
You can’t perform that action at this time.
0 commit comments