2025 survey: Proposed cuts to survey questions #7
Conversation
surveys/sphinx-survey-2025.yml
Outdated
| # Motivation: Understand the responder's self-reported background and skills. | ||
| - title: "Do you most often work in a team or independently?" | ||
| other: true | ||
| choices: | ||
| - "I most often work on projects independently" | ||
| - "I most often work on projects as part of a team" | ||
| - "I spend about equal time working on projects independently as I do on a | ||
| team" | ||
| - "Prefer not to answer" | ||
|
|
There was a problem hiding this comment.
I do not think there were intentions to remove this. Can we restore the question?
There was a problem hiding this comment.
I can restore it. No one specifically asked for this removed, I removed it on general feedback on the length of the survey.
surveys/sphinx-survey-2025.yml
Outdated
| @@ -82,14 +70,12 @@ questions: | |||
| other: true | |||
| choices: | |||
| - "Academia" | |||
| - "Analytics / Visualisation" | |||
| - "Data Science" | |||
| - "Data Science / Analytics / Visualisation" | |||
There was a problem hiding this comment.
I think vis is distinct enough that it should not be grouped with DS/Analytics. There are a lot of folks that do vis as part of other disciplines like journalism for example
There was a problem hiding this comment.
I can separate them again. I do know people may not do everything in a category, but I wasn't aware of us needing to know that difference in population for the purpose of understanding Sphinx usage at a high level.
surveys/sphinx-survey-2025.yml
Outdated
| # Motivation: Reflect on priorities for documentation in general. | ||
| - title: >- | ||
| Which of the following is most important to you in a documentation site? | ||
| multiple: true | ||
| other: true | ||
| choices: | ||
| - "Ease of use" | ||
| - "Frequent updates" | ||
| - "Performance" | ||
| - "Stability" | ||
| - "Variety of features" | ||
|
|
There was a problem hiding this comment.
This was not planned for cutting can we restore please?
There was a problem hiding this comment.
I can restore it. This was another question I removed it on general feedback on the length of the survey.
There was a problem hiding this comment.
IIRC the concerns were on the lenght/number of options on some questions vs. the actual survey length? So maybe need to double check.
surveys/sphinx-survey-2025.yml
Outdated
| @@ -82,14 +70,12 @@ questions: | |||
| other: true | |||
| choices: | |||
| - "Academia" | |||
| - "Analytics / Visualisation" | |||
| - "Data Science" | |||
| - "Data Science / Analytics / Visualisation" | |||
| - "Embedded / Hardware" | |||
| - "Enterprise" | |||
There was a problem hiding this comment.
Since we are looking at ecosystems I think enterprise can be removed.
surveys/sphinx-survey-2025.yml
Outdated
| @@ -82,14 +70,12 @@ questions: | |||
| other: true | |||
| choices: | |||
| - "Academia" | |||
There was a problem hiding this comment.
Perhaps better as Research / Academia / Research Software
surveys/sphinx-survey-2025.yml
Outdated
| - 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: | ||
| - "Google format" | ||
| - "Numpydoc format" | ||
| - "Sphinx format" | ||
| - "Markdown" | ||
| - "I don’t know" | ||
| - "I do not write docstrings" |
There was a problem hiding this comment.
I would still be interested in the result because it could tell priorities on the development of the napoleon extension. I agree though that the description is too lengthy.
Let's trim to this:
- title: "Which Python docstring style do you use?"
multiple: true
other: true
choices:
- "Google format"
- "Numpydoc format"
- "I don’t know"
- "I do not write docstrings"
There may be more people in the "I don't know category". But that's ok. I also removed "Sphinx format" and "Markdown" because they are IMHO less and we have "other" anyway. @AA-Turner what do you think?
There was a problem hiding this comment.
I would be happy to keep these too.
Perhaps instead of the explicit syntax we can add a hyperlink to the examples in https://sphinxcontrib-napoleon.readthedocs.io/en/latest/index.html ?
There was a problem hiding this comment.
Both with or without the link would be ok for me.
|
Commenting to move this up inboxes again. Is there anything I can change in this PR to help move the survey forward or are we waiting on the other requested cuts (the ones I don't have the expertise for alone)? |
There was a problem hiding this comment.
@AA-Turner I think this is now ready, can you please give this a last review and perhaps a merge if you're ok with this.
I can then follow up with a PR to slim down the multiple-choice questions that have too many options right now.
Co-authored-by: Tania Allard <taniar.allard@gmail.com>
|
@AA-Turner sorry for the ping again, would it be possible to get this merged? Thanks! |
|
@trallard sorry for the delay. |
|
Not a problem, thanks 🙏🏽 |
Demonstrating the proposal for survey question and option cuts as I described in this comment.
I don't think this PR has to be merged if we decide not to make these cuts. I'm also open to further cuts as there were several questions I don't have the expertise to review the options for.
Thank you!