From 7a64dea885c6fcaf71e654a4be9e920dc21c3bab Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Mon, 1 Jul 2024 12:15:32 -0400 Subject: [PATCH] remove TODO about how vs when #10531 --- doc/sphinx-guides/source/contributor/documentation.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/doc/sphinx-guides/source/contributor/documentation.md b/doc/sphinx-guides/source/contributor/documentation.md index 6a24e653152..12a4266c9ff 100644 --- a/doc/sphinx-guides/source/contributor/documentation.md +++ b/doc/sphinx-guides/source/contributor/documentation.md @@ -154,8 +154,6 @@ A good documentation is just like a website enhanced and upgraded by adding high While PNGs in the git repo can be linked directly via URL, Sphinx-generated images do not need a manual step and might provide higher visual quality. Especially in terms of quality of content, generated images can be extendend and improved by a textbased and reviewable commit, without needing raw data or source files and no diff around. -TODO: The above covers "how" but what about "when"? - ### Cross References When adding ReStructured Text (.rst) [cross references](https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#ref-role), use the hyphen character (`-`) as the word separator for the cross reference label. For example, `my-reference-label` would be the preferred label for a cross reference as opposed to, for example, `my_reference_label`.