search

CGAL / cgal

The public CGAL repository, see the README below
https://github.com/CGAL/cgal#readme
Other
4.68k stars 1.35k forks source link

Boolean Set Operations: Fix brief descriptions #8131

Closed afabri closed 2 months ago

afabri commented 3 months ago

Summary of Changes

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

Release Management

afabri commented 3 months ago

/build:v0

github-actions[bot] commented 3 months ago

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

afabri commented 3 months ago

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 commented 2 months ago

I'd prefer using "respectively"

afabri commented 2 months ago

@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 commented 2 months ago

@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 commented 2 months ago

Successfully tested in CGAL-6.0-Ic-228