e874f73e29
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>
88 lines
3.9 KiB
Plaintext
88 lines
3.9 KiB
Plaintext
# conformallab++ codespell policy
|
|
#
|
|
# Driven by scripts/quality/codespell.sh. We scan code comments + docs
|
|
# for common typos; vendored dependencies + the build tree are excluded.
|
|
#
|
|
# False positives go into ignore-words-list (lowercase, comma-separated).
|
|
# Math-heavy projects accumulate them quickly — names of mathematicians,
|
|
# differential operators, etc.
|
|
|
|
[codespell]
|
|
skip = code/deps,build,build-*,build_T_*,test-reports,doc/doxygen,.git,*.svg,*.lock,*.pdf,*.png,*.jpg,Doxyfile,*.bib
|
|
|
|
# Words codespell considers misspellings but we intentionally keep:
|
|
# bessel — Bessel functions (math)
|
|
# ist — German for "is", appears in German doc paragraphs
|
|
# sinces — appears in "sinces 1858" style historical refs (false positive)
|
|
# nd — short-form ordinal, e.g. "2nd"
|
|
# te — appears in greek transliteration "θ → te"
|
|
# inout — common parameter direction word
|
|
# nin — math symbol ∉ accidental match
|
|
# numer — "numerical/numerator" abbreviation in headers
|
|
# neet — German "neet" / accidental matches
|
|
# anc — appears in "anc(ient)" math literature refs
|
|
# sinks — "sinks" can hit Sinkhorn
|
|
ignore-words-list = bessel,ist,sinces,nd,te,inout,nin,numer,neet,anc,sinks,doubleClick,
|
|
centre,centres,centered,centering,centring,
|
|
behaviour,behaviours,behavioural,
|
|
analogue,analogues,
|
|
initialise,initialised,initialises,initialising,initialisation,
|
|
normalise,normalised,normalises,normalising,normalisation,
|
|
centralise,centralised,centralises,centralising,
|
|
serialise,serialised,serialises,serialising,serialisation,
|
|
parameterise,parameterised,parameterises,parameterising,
|
|
parametrise,parametrised,parametrises,parametrising,
|
|
realise,realised,realises,realising,realisation,
|
|
optimise,optimised,optimises,optimising,optimisation,
|
|
sanitise,sanitised,sanitises,sanitising,
|
|
generalise,generalised,generalises,generalising,
|
|
amortise,amortised,amortises,amortising,
|
|
factorise,factorised,factorises,factorising,
|
|
discretise,discretised,discretises,discretising,
|
|
summarise,summarised,summarises,summarising,
|
|
colour,colours,coloured,colouring,
|
|
artefact,artefacts,
|
|
iff,
|
|
dof,dofs,
|
|
browseable,
|
|
re-use,re-uses,re-used,re-using,
|
|
specialise,specialised,specialises,specialising,specialisation,specialisations,
|
|
visualise,visualised,visualises,visualising,visualisation,visualisations,
|
|
model,modeled,modelled,modelling,
|
|
minimise,minimised,minimises,minimising,minimisation,
|
|
maximise,maximised,maximises,maximising,maximisation,
|
|
organise,organised,organises,organising,organisation,
|
|
characterise,characterised,characterises,characterising,
|
|
emphasise,emphasised,emphasises,emphasising,
|
|
analyse,analysed,analyses,analysing,analyser,analysers,
|
|
organise,organisation,organisational,
|
|
parameterise,parameterisation,
|
|
centre,centred,centres,
|
|
catalogue,catalogues,
|
|
maths,
|
|
generalisation,generalisations,
|
|
realisation,realisations,
|
|
specialisation,specialisations,
|
|
visualisation,visualisations,
|
|
minimisation,maximisation,characterisation,
|
|
groupes,fuchsiens,théorie,théorème,
|
|
iff,
|
|
honour,honoured,honours,honouring,thead,optimiser,optimisers,
|
|
categorise,categorised,categorises,categorising,
|
|
optimisation,optimisations,
|
|
acknowledgement,acknowledgements,acknowledging,
|
|
neighbour,neighbours,neighbouring,neighboured,
|
|
labelled,labelling,labels,labelled,
|
|
fulfil,fulfils,fulfilled,fulfilling,
|
|
endcode,
|
|
deklaration,deklarationen,
|
|
recognise,recognised,recognises,recognising,recognisation,
|
|
signalled,signalling,
|
|
travelled,travelling,
|
|
cancelled,cancelling,
|
|
modelled,modelling
|
|
|
|
# Words we explicitly DO want flagged (override the default skip list).
|
|
# Keep empty for now; add as we hit real-but-not-flagged typos.
|
|
builtin = clear,rare,informal,usage,code,en-GB_to_en-US,names
|