Skip to content

Clarify SpriteSolidColor and SpriteCircle docstrings#1319

Merged
einarf merged 1 commit intopythonarcade:developmentfrom
pushfoo:clarify_colorsprite_docstrings
Sep 9, 2022
Merged

Clarify SpriteSolidColor and SpriteCircle docstrings#1319
einarf merged 1 commit intopythonarcade:developmentfrom
pushfoo:clarify_colorsprite_docstrings

Conversation

@pushfoo
Copy link
Member

@pushfoo pushfoo commented Sep 6, 2022

Built & tested locally.

This PR clarifies the SpriteSolidColor and SpriteCircle docstrings by making the following changes:

  • Use more precise language in describing the shapes (circle instead of ellipse)
  • Succinctly explain the user impact of the texture generation & caching behavior
  • Explain the direction of the gradient for SpriteCircle
  • Sync the types of arguments and their annotation in the docstrings

@einarf
Copy link
Member

einarf commented Sep 9, 2022

I'll just merge this. We can update when we change it to only make white textures.

@einarf einarf merged commit a551774 into pythonarcade:development Sep 9, 2022
@pushfoo pushfoo deleted the clarify_colorsprite_docstrings branch September 9, 2022 00:35
@pushfoo
Copy link
Member Author

pushfoo commented Sep 9, 2022

@einarf I think we might want to set color to a keyword arg to get the best of both worlds.

@einarf
Copy link
Member

einarf commented Sep 9, 2022

Should not be a problem. Default white then?

@pushfoo
Copy link
Member Author

pushfoo commented Sep 9, 2022

Yes, for both of them. I'd also like to take consider changing some of the related underlying functionality after I finish my current experiment and reflect on it for a bit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants