Skip to content

Conversation

damusss
Copy link
Member

@damusss damusss commented Jun 1, 2025

Some parts of the docs had smaller errors. Some parts were basically lying. Big methods and the constructor where very convoluted throwing information randomly. I didn't change everything, but rephrased things. Also, in the constructor and in convert, I thought that the docs weren't even trying to explain how the arguments worked, so I looked at the actual code and refined them. I'm open for suggestions of course.

@damusss damusss requested a review from a team as a code owner June 1, 2025 12:14
@damusss damusss added the docs label Jun 1, 2025
Copy link
Member

@oddbookworm oddbookworm left a comment

Choose a reason for hiding this comment

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

Just a few comments lol, thanks @damusss 🎉

@damusss
Copy link
Member Author

damusss commented Jun 2, 2025

I've addressed most of @oddbookworm 's comments and I also fixed get_alpha again. I took the liberty of moving locking related methods at the bottom, and I would like the liberty of moving the width, height and size properties at the top.

@damusss damusss requested a review from oddbookworm June 5, 2025 13:12
@ankith26 ankith26 added this to the 2.5.6 milestone Jun 7, 2025
Copy link
Contributor

@aatle aatle left a comment

Choose a reason for hiding this comment

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

nice work 👍, it was about time these docs got updated

@Starbuck5
Copy link
Member

Great idea for an improvement, Damus. It may be wise to split this out into smaller PRs to get it through, there's already been a ton of conversation and probably will be a bunch more, this is that kind of PR. But parts of this likely could have gotten through already, like you doing surface -> Surface all over the place.

@Starbuck5 Starbuck5 marked this pull request as draft July 27, 2025 19:44
@damusss
Copy link
Member Author

damusss commented Oct 8, 2025

@Starbuck5 Made this stall because of the end of high school. I'll push a few smaller PRs so it can get in

Copy link
Contributor

coderabbitai bot commented Oct 8, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@damusss
Copy link
Member Author

damusss commented Oct 8, 2025

Thank you @aatle for noticing all those typos and inconsistencies. I tried to address them.

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants