Timeline for Using "iff" in documentation
Current License: CC BY-SA 4.0
11 events
| when toggle format | what | by | license | comment | |
|---|---|---|---|---|---|
| Nov 22, 2024 at 6:38 | comment | added | MisterMiyagi | @freakish At least the ReST underlying Sphinx generated documentation supports footnotes. | |
| Nov 18, 2024 at 15:59 | comment | added | Joop Eggen | @DocBrown much obliged; my (non native) English is normally better, so my earnest thanks. | |
| Nov 18, 2024 at 14:11 | history | edited | Doc Brown | CC BY-SA 4.0 | Fixed typos and wording. |
| Nov 18, 2024 at 13:30 | history | edited | candied_orange | CC BY-SA 4.0 | added 2 characters in body |
| Nov 18, 2024 at 13:13 | comment | added | Joop Eggen | @DocBrown corrected two most evidint typos, though the text still should be formulated differently here and there. Thanks. | |
| Nov 18, 2024 at 13:10 | history | edited | Joop Eggen | CC BY-SA 4.0 | added 2 characters in body |
| Nov 18, 2024 at 12:56 | comment | added | Joop Eggen | Thanks in general. Documentation in code has only the room of a popup for a method's javadoc or such. Probably senseless. | |
| Nov 18, 2024 at 12:35 | comment | added | Doc Brown | @freakish: it is unclear whether the OP meant "documentation in source code" or "separate documentation". Maybe they have literate programming in mind - which uses TeX for creating the docs, which is surely capable of adding footnotes ;-). But don't get me wrong, I agree that footnotes are impractical for source code docs. | |
| Nov 18, 2024 at 11:43 | comment | added | freakish | Except you won't write a foot note in a source code. And I'm not sure if any doc generator supports it, I've never seen it. | |
| Nov 18, 2024 at 11:36 | comment | added | Hans-Martin Mosner | Footnote is a good solution - it explains the term close to its occurrence and does not hamper the reading flow for those who are already familiar with the word. | |
| Nov 18, 2024 at 11:09 | history | answered | Joop Eggen | CC BY-SA 4.0 |