Skip to content

Commit

Permalink
remove TODO about how vs when IQSS#10531
Browse files Browse the repository at this point in the history
  • Loading branch information
pdurbin committed Jul 1, 2024
1 parent 9bd0ccf commit 7a64dea
Showing 1 changed file with 0 additions and 2 deletions.
2 changes: 0 additions & 2 deletions doc/sphinx-guides/source/contributor/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down

0 comments on commit 7a64dea

Please sign in to comment.