conformallab/ConformalLabpp
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

docs+lint: post-merge consistency fixes after PRs #17/#18/#19 landed

Browse Source 
Three small cleanups surfaced by running the full gate sweep on the
merged main:

1. CGAL conventions (CGAL-2 \\file briefs)
   doc-only headers `Conformal_map/doxygen_groups.h` and
   `Conformal_map/doxygen_namespaces.h` were missing the `\\file`
   brief required by the CGAL conventions check.  Added both.

2. codespell — three new triggers
   `code/tests/cgal/CMakeLists.txt` uses "honour", `doc/reviewer/hub.html`
   uses `<thead>` (HTML tag, false-positive for "thread"), and
   `doc/roadmap/research-track.md` uses "optimiser".  All three are
   British-English / HTML usage; added to `.codespellrc` ignore list.

3. Doxygen warning in `doc/architecture/compile-time.md:250`
   A trailing backtick-quoted CMake flag at end-of-file confused
   Doxygen's markdown parser into starting a never-closing verbatim
   block.  Rewrote the line to put the prose first and the backtick
   in the middle, not at end-of-file.

All gates green again on the merged main:
  ✅ 259/259 tests pass
  ✅ test-count consistency
  ✅ markdown links 166/166 resolve
  ✅ CGAL conventions 0/8 violations
  ✅ license-headers 68/68 carry MIT SPDX
  ✅ codespell 0 typos
  ✅ shellcheck 0 findings (18 scripts)
  ✅ Doxygen 100% coverage, 0 warnings

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
Tarik Moussa
2026-05-26 11:19:55 +02:00
parent 3953d1549b
commit e874f73e29
4 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.codespellrc
View File

@@ -67,6 +67,7 @@ ignore-words-list = bessel,ist,sinces,nd,te,inout,nin,numer,neet,anc,sinks,doubl
minimisation,maximisation,characterisation, minimisation,maximisation,characterisation,
groupes,fuchsiens,théorie,théorème, groupes,fuchsiens,théorie,théorème,
iff, iff,
honour,honoured,honours,honouring,thead,optimiser,optimisers,
categorise,categorised,categorises,categorising, categorise,categorised,categorises,categorising,
optimisation,optimisations, optimisation,optimisations,
acknowledgement,acknowledgements,acknowledging, acknowledgement,acknowledgements,acknowledging,

3
code/include/CGAL/Conformal_map/doxygen_groups.h
View File

@@ -1,4 +1,7 @@
// Copyright (c) 2024-2026 Tarik Moussa. // Copyright (c) 2024-2026 Tarik Moussa.
/*! \file CGAL/Conformal_map/doxygen_groups.h
\brief Doxygen `\defgroup` registrations for the Conformal_map package.
*/
// SPDX-License-Identifier: MIT // SPDX-License-Identifier: MIT
// //
// This header contains only Doxygen \defgroup commands. It is included // This header contains only Doxygen \defgroup commands. It is included

3
code/include/CGAL/Conformal_map/doxygen_namespaces.h
View File

@@ -1,4 +1,7 @@
// Copyright (c) 2024-2026 Tarik Moussa. // Copyright (c) 2024-2026 Tarik Moussa.
/*! \file CGAL/Conformal_map/doxygen_namespaces.h
\brief Doxygen `\namespace` documentation blocks for the project namespaces.
*/
// SPDX-License-Identifier: MIT // SPDX-License-Identifier: MIT
// //
// Doxygen namespace documentation only — no declarations. Centralised // Doxygen namespace documentation only — no declarations. Centralised

4
doc/architecture/compile-time.md
View File

@@ -246,5 +246,5 @@ non-Apple toolchain typically delivers 80 %+ hit rates with ccache.
The lever is shipped on by default because it's neutral when it The lever is shipped on by default because it's neutral when it
doesn't help and 10× speedup when it does. doesn't help and 10× speedup when it does.
To force-disable for clean from-scratch measurements: To force-disable for clean from-scratch measurements, pass the
`-DCONFORMALLAB_USE_CCACHE=OFF`. CMake flag `-DCONFORMALLAB_USE_CCACHE=OFF` at configure time.