Skip to content

Commit 2ca929b

Browse files
authored
Add suggestions to survey (#5)
1 parent 63ec239 commit 2ca929b

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

surveys/sphinx-survey-2025.yml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -174,10 +174,10 @@ questions:
174174
multiple: true
175175
other: true
176176
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)"
178180
- "Markdown"
179-
- "Numpydoc format (underlined sections)"
180-
- "Sphinx format (reStructuredText)"
181181
- "I don’t know"
182182

183183
# Motivation: Reflect on priorities for documentation in general.
@@ -268,7 +268,7 @@ questions:
268268
- "Sphinx Book"
269269
- "Sphinx Bootstrap"
270270
- "Sphinx Immaterial"
271-
- "Something else/I don’t know"
271+
- "I don’t know"
272272

273273
# Motivation: Explore patterns in Sphinx output priorities. This might be useful for contextualizing other answers.
274274
- title: "In which formats do you publish your documentation with sphinx?"
@@ -297,7 +297,9 @@ questions:
297297
- "No native support for Markdown"
298298
- "Performance issues"
299299
- "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"
301303
- "Sphinx is missing features I want"
302304

303305
# Motivation: Explore patterns in what people using Sphinx struggle with.

0 commit comments

Comments
 (0)