Menu

#790 User Guide: Reports Menu page duplicates report names/descriptions between summary list and sub-page links (GTK3V2MAIN)

fixed
nobody
None
2026-09-10
2026-09-10
No

docs/app/doc/reportsm.dox's Reports Menu page had two separate lists for the same
7 reports: a descriptive bulleted list (name + one-line description, linking via \ref) followed
immediately by a second, bare \subpage-only list repeating the same 7 links just to establish the
Doxygen page hierarchy (\subpage is required, not \ref, for a page to nest under its parent in the
generated navigation tree).

Also, the descriptive list's wording closely duplicated each linked report's own opening sentence
on its sub-page (e.g. Kinked Joints Report: near-identical phrasing between the summary bullet and
the target page's first sentence).

Fix: merged the two lists into one, using \subpage inline (keeps both the link and the page
hierarchy), and shortened each bullet to a short non-duplicating clause after the link (which
already renders the reports own name/title) instead of restating the report name and re-describing
it in near-identical wording to the target page.

Discussion

  • Allen D Byrne

    Allen D Byrne - 2026-09-10

    git PR #187 merged into GTK3V2MAIN (27/27 CI green). Hg branch
    bug-790-reportsm-dox-duplicate-lists-gtk3 pushed to SF (tip 772c6988f62d).

    Independent of the Layer Groups feature (#782/#787/#789) -- pure Reports Menu doc cleanup, not
    gated on that feature's dev-ML review. Held for the normal review window before Hg-mainline
    merge, same as any other ticket.

     
  • Allen D Byrne

    Allen D Byrne - 2026-09-10

    Merged into GTK3V2MAIN Hg mainline (rev 6517aafe2e48), pushed to SF -- exception granted
    to merge now rather than waiting the normal review window, since this is a pure documentation fix
    independent of the Layer Groups feature.

    Note: the original bug-790-reportsm-dox-duplicate-lists-gtk3 branch could not be merged/grafted
    directly (its diff was computed against bug-787's tip, which already has #787's own further
    changes to this file, not yet in mainline) -- applied the identical fix by hand directly against
    mainline's actual content instead.

     

Anonymous
Anonymous

Add attachments
Cancel