Skip to content

2025 survey: Proposed cuts to survey questions #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 2, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 7 additions & 35 deletions surveys/sphinx-survey-2025.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,7 @@ questions:
- "Academic researcher"
- "Data scientist"
- "Manager"
- "ML engineer / MLOps"
- "Product manager"
- "QA engineer"
- "Software Developer / Programmer / Engineer"
- "Student (in full-time education)"
- "Technical support"
Expand All @@ -81,15 +79,13 @@ questions:
multiple: true
other: true
choices:
- "Academia"
- "Analytics / Visualisation"
- "Data Science"
- "Academia / Research / Research Software"
- "Data Science / Analytics"
- "Data Visualisation"
- "Embedded / Hardware"
- "Enterprise"
- "Game Development"
- "Infrastructure / DevOps"
- "Machine Learning"
- "Mobile Development"
- "Multimedia / Creative"
- "Scientific Python"
- "Web"
Expand Down Expand Up @@ -220,27 +216,6 @@ questions:

# Motivation: Understand the constellation of tools for documentation this responder works with.
- title: "Which Python docstring style do you use?"
description: >-
Select N/A if you don’t use Python or Python docstrings.

Google-style docstrings look like:
```rst
Arguments:
my_param (type): description
```

Numpydoc-style docstrings look like:
```rst
Arguments
---------
my_param : type
description
```

Sphinx-style docstrings look like:
```rst
:param [my_param]: description
```
multiple: true
other: true
choices:
Expand Down Expand Up @@ -310,14 +285,11 @@ questions:
- "Creating non-HTML output formats"
- "I joined a project that was already using Sphinx"
- "It has native support for documenting multiple languages"
- "It's open source / permissively licenced"
- "Other projects in my ecosystem were using Sphinx"
- "Someone on my team knew how to use Sphinx"
- "Sphinx's community and support"
- "It’s open source / permissively licenced"
- "Other projects or team members were using Sphinx"
- "Sphinx’s community and support"
- "Sphinx’s ease of use"
- "Sphinx’s performance"
- "Sphinx’s release schedule"
- "Sphinx’s stability"
- "Sphinx’s Good performance"
- "Support for advanced document markup features"
- "The internationalisation and translation support"
- "The theme and extension APIs and ecosystem"
Expand Down