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.

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

Fix for ClippingPolygon equals function #12394

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

javagl
Copy link
Contributor

@javagl javagl commented Dec 25, 2024

Description

Until now, this only fixes the JSDoc parameter type for ClippingPolygon#equals from Plane to ClippingPolygon.

See additional comments in the issue.

Issue number and link

#12389

Testing plan

For now, there's not much to test. With main, running npm run build.ts generated

export class ClippingPolygon {
...
    /**
     * Compares the provided ClippingPolygons and returns
    <code>true</code> if they are equal, <code>false</code> otherwise.
     * @param left - The first polygon.
     * @param right - The second polygon.
     * @returns <code>true</code> if left and right are equal, <code>false</code> otherwise.
     */
    static equals(left: Plane, right: Plane): boolean;

and now it generates

export class ClippingPolygon {
...
    /**
     * Compares the provided ClippingPolygons and returns
    <code>true</code> if they are equal, <code>false</code> otherwise.
     * @param left - The first polygon.
     * @param right - The second polygon.
     * @returns <code>true</code> if left and right are equal, <code>false</code> otherwise.
     */
    static equals(left: ClippingPolygon, right: ClippingPolygon): boolean;

Author checklist

  • I have submitted a Contributor License Agreement
  • I have added my name to CONTRIBUTORS.md
  • I have updated CHANGES.md with a short summary of my change
  • I have added or updated unit tests to ensure consistent code coverage
  • I have updated the inline documentation, and included code examples where relevant
  • I have performed a self-review of my code

@javagl javagl changed the title Fix for ClippingPolygon equals funciton Fix for ClippingPolygon equals function Dec 25, 2024
Copy link

Thank you for the pull request, @javagl!

✅ We can confirm we have a CLA on file for you.

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.

1 participant