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

Update valid combinations of parameters for intersection() function in documentation #8760

Closed
wants to merge 1 commit into from

Conversation

ksandeep18
Copy link

This pull request addresses issue #8756 by updating the documentation for the intersection() function in the Polygon_mesh_processing.txt file. The valid combinations of parameters for the intersection() function were missing, and this PR adds the following combinations:

  • Point and Circle
  • Point and Sphere
  • Line and Plane
  • Line and Triangle
  • Segment and Triangle
  • Ray and Triangle
  • Triangle and Triangle

These updates ensure that the documentation accurately reflects the supported parameter combinations for the intersection() function.

Changes Made

  • Updated the Polygon_mesh_processing.txt file to include the missing valid combinations of parameters for the intersection() function.

File Changed

  • cgal/Polygon_mesh_processing/doc/Polygon_mesh_processing/Polygon_mesh_processing.txt

Related Issue

Checklist

  • Documentation updated
  • No new warnings introduced

Please review the changes and let me know if any further modifications are needed.

Additional Notes:
This PR only includes documentation updates and does not affect the functionality of the codebase. The changes are intended to improve the clarity and completeness of the documentation for users of the CGAL::Polygon_mesh_processing::intersection() function.

@sloriot
Copy link
Member

sloriot commented Feb 28, 2025

The issue is in the kernel package, not Polygon_mesh_processing.

@sloriot sloriot closed this Feb 28, 2025
@ksandeep18
Copy link
Author

Thank you for pointing that out. I apologize for the mistake in identifying the correct package. I'll create a new PR targeting the kernel package instead. Is there anything specific I should keep in mind when creating the new pull request for the kernel package?

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.

The reference-manual page of intersection() is missing some valid combinations of parameters
2 participants