Reduce amount of usage of "dummy" in codebase to minimum #2547
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dr0id
reviewed
Nov 5, 2023
MyreMylar
commented
Nov 5, 2023
MyreMylar
commented
Nov 5, 2023
MyreMylar
commented
Nov 5, 2023
dr0id
approved these changes
Nov 5, 2023
dr0id
reviewed
Nov 5, 2023
# Conflicts: # src_c/_sprite.c # src_c/cython/pygame/_sprite.pyx
I was initially going to save these for another PR, but there were actually only a few (I realised once I deleted the generated documentation). So I've bundled them in as well. Now the only remaining instances of dummy are all related to the SDL video driver. I suspect SDL will be unable to simply rename this simply as it is a string used all over the place in other people's code. Other potential ideas:
|
dr0id
approved these changes
Nov 6, 2023
Starbuck5
approved these changes
Nov 19, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
partially fixes #1218 - may be about as good code-side as we can do code side due to relying on external libraries which will struggle to change over things due to public API.
Motivation
See: https://developers.google.com/style/inclusive-documentation for one example, but there are other similar inclusive language style guides.
This guide recommends 'placeholder variable' where we might currently use 'dummy variable'. Pandas had a long back and forth on the topic here. I'm aware not everyone will agree with this but it seems a fairly easy switch to reduce our exposure on this topic.