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

Warnings in documentation when running xmllint #8014

Merged

Conversation

albert-github
Copy link
Contributor

When running xmllint over the documentation output we get a number of waning's like:

save_Periodic_2_triangulation_2/class_c_g_a_l_1_1_periodic__2__triangulation__2.html:1420: parser error : Opening and ending tag mismatch: dd line 1420 and div
"This is an advanced function.">is_triangulation_in_1_sheet()</a></code>  </div>
                                                                               ^

they are a consequence of the fact that a a command is not properly ended in this case we have a \pre command and its documentation states:

The \pre command ends when a blank line or some other sectioning command is encountered.

and in this case the command is followed by the \cgalAdvancedEnd command that does not properly end the \pre command. The same is valid in the other cases.

… waning's like:

```
save_Periodic_2_triangulation_2/class_c_g_a_l_1_1_periodic__2__triangulation__2.html:1420: parser error : Opening and ending tag mismatch: dd line 1420 and div
"This is an advanced function.">is_triangulation_in_1_sheet()</a></code>  </div>
                                                                               ^
```
they are a consequence of the fact that a a command is not properly ended in this case we have a `\pre` command and its documentation states:
> The `\pre` command ends when a blank line or some other sectioning command is encountered.

and in this case the command is followed by the `\cgalAdvancedEnd` command that does not properly end the `\pre` command.
The same is valid in the other cases.
@lrineau lrineau added the Doc bug label Feb 6, 2024
@lrineau lrineau added this to the 6.0-beta milestone Feb 6, 2024
@sloriot
Copy link
Member

sloriot commented Feb 13, 2024

Successfully tested in CGAL-6.0-Ic-169

@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 Feb 13, 2024
@lrineau lrineau self-assigned this Feb 13, 2024
@lrineau lrineau merged commit 4ea0ae2 into CGAL:master Feb 13, 2024
8 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 Feb 13, 2024
@lrineau lrineau deleted the feature/bug_doc_advanced_paragraph branch February 13, 2024 10:27
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.

3 participants