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.

Sign up for GitHub

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

Jump to bottom

Documentation in Triangulation package #8075

Closed
albert-github opened this issue Mar 16, 2024 · 3 comments
Closed

Documentation in Triangulation package #8075

albert-github opened this issue Mar 16, 2024 · 3 comments
Labels
Doc Pkg::Triangulation_d
Milestone
6.0-beta

Comments

@albert-github
Copy link
Contributor

In the file Triangulation/doc/Triangulation/Triangulation.txt around line 408 we have the construct:

hole is ``star shaped'' around

and doxygen will transform this into (see Triangulation/index.html):

hole is `‘star shaped’' around

resulting in:
image

The question here is which type of quotes are intended here (as in my opinion the current output is not so nice) ?
@albert-github albert-github changed the title Documentation in Trangualtion package Documentation in Triangulation package Mar 16, 2024
@mglisse
Copy link
Member

mglisse commented Mar 16, 2024

The intent was probably "the same behavior as latex".

@albert-github
Copy link
Contributor Author

@mglisse thanks for the pointer so something like:

image

albert-github added a commit to albert-github/cgal that referenced this issue Mar 16, 2024
@albert-github
issue CGAL#8075 Documentation in Triangulation package
f167a90 
replace the, for doxygen and thus for the output, strange constructs with better constructs.
@albert-github
Copy link
Contributor Author

I've just pushed a proposed patch, pull request #8076

@MaelRL MaelRL added this to the 6.0-beta milestone Mar 20, 2024
@sloriot sloriot mentioned this issue Mar 20, 2024
Closed
lrineau added a commit that referenced this issue Mar 22, 2024
@lrineau
Merge pull request #8076 from albert-github/feature/issue_8075
f6c1153 
issue #8075 Documentation in Triangulation package
@MaelRL MaelRL closed this as completed Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Doc Pkg::Triangulation_d
Projects
None yet
Milestone
6.0-beta
Development

No branches or pull requests
3 participants
@MaelRL @albert-github @mglisse