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

Boolean Set Operations: Fix brief descriptions #8131

Merged
merged 3 commits into from
Apr 25, 2024

Conversation

afabri
Copy link
Member

@afabri afabri commented Apr 10, 2024

Summary of Changes

Add a "\" after "resp." so that doxygen is not mislead by the "." as end of a brief description.

Release Management

  • Affected package(s): Boolean_set_operations_2
  • License and copyright ownership: unchanged

@afabri
Copy link
Member Author

afabri commented Apr 10, 2024

/build:v0

Copy link

The documentation is built. It will be available, after a few minutes, here: https://cgal.github.io/8131/v0/Manual/index.html

@afabri
Copy link
Member Author

afabri commented Apr 10, 2024

It is fixed in the built documentation, e.g., for join() to check that it works in principle. In case someone (@sloriot , @efifogel ) wants to check it in detail I think it is easier to just read the diff in the "Files Changed" tab instead of going through all html pages.

@sloriot
Copy link
Member

sloriot commented Apr 10, 2024

I'd prefer using "respectively"

@afabri
Copy link
Member Author

afabri commented Apr 18, 2024

@JacksonCampolattaro do you have an opinion on the usage of respectively or resp. here? I am even wondering if it should only be used in the second parenthesis.

@JacksonCampolattaro
Copy link
Member

@JacksonCampolattaro do you have an opinion on the usage of respectively or resp. here? I am even wondering if it should only be used in the second parenthesis.

I prefer using the full word; the sentence is already pretty dense, so abbreviation could make it less clear.

I'm not used to seeing respecively used in the middle of a sentence; I don't think it's wrong, but reversing the phrasing would be more intuitive to me:

If substituted with CGAL::Tag_true (default), pgn1 and pgn2 are bounded by polylines before the operation is performed, converting them into a general polygon and a general polygon with holes, respectively.

@sloriot sloriot added the TODO label Apr 19, 2024
@sloriot sloriot force-pushed the Aos_2-brief_doc-GF branch from aa10b5c to 3a32338 Compare April 22, 2024 07:31
@sloriot
Copy link
Member

sloriot commented Apr 24, 2024

Successfully tested in CGAL-6.0-Ic-228

@lrineau lrineau self-assigned this Apr 25, 2024
@lrineau lrineau added the rm only: ready for master For the release team only: that indicates that a PR is about to be merged in 'master' label Apr 25, 2024
@lrineau lrineau merged commit d9a8aa2 into CGAL:master Apr 25, 2024
9 checks passed
@lrineau lrineau removed the rm only: ready for master For the release team only: that indicates that a PR is about to be merged in 'master' label Apr 25, 2024
@lrineau lrineau deleted the Aos_2-brief_doc-GF branch April 25, 2024 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants