The reference-manual page of intersection() is missing some valid combinations of parameters #8756
Comments
|
@efifogel do you add it? Just to avoid that two people or nobody does. |
|
No, I didn't
…On Thu, Feb 27, 2025, 09:15 Andreas Fabri ***@***.***> wrote:
@efifogel <https://github.com/efifogel> do you add it? Just to avoid that
two people or nobody does.
—
Reply to this email directly, view it on GitHub
<#8756 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABVBNOCFJN7VKCBL4GXA3W32R23QXAVCNFSM6AAAAABX6FEJLCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMOBXGA4TSMJSGE>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
[image: afabri]*afabri* left a comment (CGAL/cgal#8756)
<#8756 (comment)>
@efifogel <https://github.com/efifogel> do you add it? Just to avoid that
two people or nobody does.
—
Reply to this email directly, view it on GitHub
<#8756 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABVBNOCFJN7VKCBL4GXA3W32R23QXAVCNFSM6AAAAABX6FEJLCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMOBXGA4TSMJSGE>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
|
When I look at this page, I would say it is documented by the sentence |
|
As I said in the description of the issue, and I quote:
One can argue that it is inferred from the text, but it's better
explicitly stated.
The term "any other type" is vague, and actually imprecise. Any other type
in CGAL? Any other type that has the _2 suffix supported by the kernel?
Anyway, it's better just to explicitly say something like:
...any other type in the above table and the Circle_2 type.
and something similar that refers to Sphere_3 under the second table.
____ _ ____ _
/_____/_) o /__________ __ //
(____ ( ( ( (_/ (_/-(-'_(/
_/
…On Thu, 27 Feb 2025 at 10:40, Andreas Fabri ***@***.***> wrote:
When I look at this page
<https://doc.cgal.org/latest/Kernel_23/group__intersection__linear__grp.html#gade00253914ac774cce3d2031c07d74fe>,
I would say it is documented by the sentence
*Additional overloads are provided for the type Point_2 combined with any
other type with the result type being std::optional< std::variant<Point_2 >
>*
—
Reply to this email directly, view it on GitHub
<#8756 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABVBNODWLZE4FE6ALVTAJG32R3FQVAVCNFSM6AAAAABX6FEJLCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMOBXGI3DIMJWGU>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
[image: afabri]*afabri* left a comment (CGAL/cgal#8756)
<#8756 (comment)>
When I look at this page
<https://doc.cgal.org/latest/Kernel_23/group__intersection__linear__grp.html#gade00253914ac774cce3d2031c07d74fe>,
I would say it is documented by the sentence
*Additional overloads are provided for the type Point_2 combined with any
other type with the result type being std::optional< std::variant<Point_2 >
>*
—
Reply to this email directly, view it on GitHub
<#8756 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABVBNODWLZE4FE6ALVTAJG32R3FQVAVCNFSM6AAAAABX6FEJLCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMOBXGI3DIMJWGU>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
This was referenced Feb 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The reference-manual page of intersection() is missing the (explicit) indication that
are also valid combinations of parameters.
(One can argue that it is inferred from the text, but it's better explicitly stated.)
Issue Details
Source Code
If your issue arises by using CGAL in your own source code, please provide a minimalist example that we can compile easily to reproduce the bug. If your issue arises from using a CGAL program (demo, example, etc.), please let us know which one. Helping you solving an issue is much easier and efficient if we can reproduce it.
Environment
The text was updated successfully, but these errors were encountered: