Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Touch-up top-level docstrings for Sprite & BasicSprite #1687

Merged
merged 5 commits into from
Apr 8, 2023
Merged

Touch-up top-level docstrings for Sprite & BasicSprite #1687

merged 5 commits into from
Apr 8, 2023

Conversation

pushfoo
Copy link
Member

@pushfoo pushfoo commented Apr 6, 2023

tl;dr

  1. Replace the hard URL link from Sprite's top-level docstring with a :ref: to this doc build's version
  2. Rephrase Sprite's docstring to be more PEP-compliant
  3. Add a top-level docstring for BasicSprite

Doc built & tested locally.

einarf
einarf reviewed Apr 6, 2023
View reviewed changes
arcade/sprite/base.py Outdated Show resolved Hide resolved
pvcraven
pvcraven requested changes Apr 6, 2023
View reviewed changes
Copy link
Member

@pvcraven pvcraven left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree with einarf. Everything else looks good to me.

arcade/sprite/base.py Outdated Show resolved Hide resolved
@pushfoo pushfoo mentioned this pull request Apr 7, 2023
Merged
@pvcraven pvcraven merged commit 1aef1ac into pythonarcade:development Apr 8, 2023
@pushfoo pushfoo deleted the touchup_sprite_top_docstring branch May 7, 2023 06:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@einarf einarf einarf left review comments

@pvcraven pvcraven pvcraven approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@pushfoo @pvcraven @einarf