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

Add module-level docs for Curve #15905

Merged
merged 3 commits into from
Oct 15, 2024
Merged

Add module-level docs for Curve #15905

merged 3 commits into from
Oct 15, 2024

Conversation

mweatherley
Copy link
Contributor

Objective

Improve the average user's ability to understand what the heck is going on with the Curve API.

Solution

I wrote some docs. I doubt these are perfect; I'm probably far too close to this for that to be the case. :)

@mweatherley mweatherley added C-Docs An addition or correction to our documentation A-Math Fundamental domain-agnostic mathematical operations X-Uncontroversial This work is generally agreed upon S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Oct 14, 2024
@torsteingrindvik torsteingrindvik self-requested a review October 14, 2024 19:59
torsteingrindvik
torsteingrindvik approved these changes Oct 14, 2024
View reviewed changes
Copy link
Contributor

@torsteingrindvik torsteingrindvik left a comment

Choose a reason for hiding this comment

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

This was a really great read. I've been wondering what's been going on with the curve APIs the last months and I feel I have some insight now and it's looking superb.

No real nits or anything (also TIL parameterized can be spelled parametrized).

@alice-i-cecile alice-i-cecile added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Oct 14, 2024
@alice-i-cecile alice-i-cecile added this to the 0.15 milestone Oct 14, 2024
MiniaczQ
MiniaczQ approved these changes Oct 15, 2024
View reviewed changes
Copy link
Contributor

@MiniaczQ MiniaczQ left a comment

Choose a reason for hiding this comment

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

The intro felt about the right level for me and if anything, it serves as a reference to what this module offers.
Then the examples after that look approachable for any level and cover most interesting use cases. :)
Great job!

@alice-i-cecile alice-i-cecile added this pull request to the merge queue Oct 15, 2024
Merged via the queue into bevyengine:main with commit 8a655e4 Oct 15, 2024
29 of 30 checks passed
@mweatherley mweatherley deleted the curve-docs branch October 15, 2024 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@torsteingrindvik torsteingrindvik torsteingrindvik approved these changes

@MiniaczQ MiniaczQ MiniaczQ approved these changes

@alice-i-cecile alice-i-cecile alice-i-cecile approved these changes

Assignees
No one assigned
Labels
A-Math Fundamental domain-agnostic mathematical operations C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it X-Uncontroversial This work is generally agreed upon
Projects
None yet
Milestone
0.15
Development

Successfully merging this pull request may close these issues.
4 participants
@mweatherley @alice-i-cecile @MiniaczQ @torsteingrindvik