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

Improved geometry docs #3043

Merged
merged 9 commits into from
Aug 15, 2024
Merged

Improved geometry docs #3043

merged 9 commits into from
Aug 15, 2024

Conversation

itzpr3d4t0r
Copy link
Member

@itzpr3d4t0r itzpr3d4t0r commented Aug 7, 2024 •
edited
Loading

This PR tries to simplify and improve geometry docs a bit.

What I tried to achieve:

  • Lessen word repetition
  • Remove obvious statements
  • Remove self references when describing methods (like saying: "The collidecircle method does ..." inside the collidecircle 's docs)
  • Uniform collision / overlap / intersect / tests / checks word usage
  • Moved Circle.move() docs from between collision methods to under collision methods
  • Shorten phrases a bit
  • Use of actual math formulas syntax

@itzpr3d4t0r itzpr3d4t0r added docs geometry pygame.geometry labels Aug 7, 2024
@itzpr3d4t0r itzpr3d4t0r requested a review from a team as a code owner August 7, 2024 09:25
@itzpr3d4t0r
fixes
10746c6
@itzpr3d4t0r
fixes
c60c381
@itzpr3d4t0r
more changes:
ef3edfd 
- now using math formulas to describe attributes
- remove more self references
- Simpler phrases
- Add missing vector2 as params
@itzpr3d4t0r
fixes
7cff3f2
@itzpr3d4t0r
remove (behaviour wise), add one extra case for good circle-like para…
496ad47 
…m, add actual link to move method inside move_ip
@itzpr3d4t0r
uniform s
2f0ffff
@itzpr3d4t0r
fix docs h
126cf47
@itzpr3d4t0r
moved equivalent code outside of notes
0e7cb7c
ankith26
ankith26 approved these changes Aug 14, 2024
View reviewed changes
Copy link
Member

@ankith26 ankith26 left a comment

Choose a reason for hiding this comment

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

LGTM on a quick skim, thanks! 🎉

@ankith26 ankith26 added this to the 2.5.2 milestone Aug 14, 2024
damusss
damusss approved these changes Aug 15, 2024
View reviewed changes
Copy link
Member

@damusss damusss left a comment

Choose a reason for hiding this comment

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

The docs sound and look much better, thanks :)

@damusss damusss merged commit 0fb59bf into pygame-community:main Aug 15, 2024
25 checks passed
@itzpr3d4t0r itzpr3d4t0r deleted the improve-geometry-docs branch August 22, 2024 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@damusss damusss damusss approved these changes

@ankith26 ankith26 ankith26 approved these changes

Assignees
No one assigned
Labels
docs geometry pygame.geometry
Projects
None yet
Milestone
2.5.2
Development

Successfully merging this pull request may close these issues.
3 participants
@itzpr3d4t0r @ankith26 @damusss