Activity for Dave Jonesâ€
| Type | On... | Excerpt | Status | Date |
|---|---|---|---|---|
| Edit | Post #12577 | Initial revision | — | almost 5 years ago |
| Edit | Post #5337 | Initial revision | — | almost 5 years ago |
| Question | — |
How to structure a sentence containing long code examples? In the context of a technical manual, I need to write instructions guiding users through several standard manipulations. When providing examples of these manipulations, I have written a short sentence containing "before" and "after" examples which appear in (potentially multi-line) vertical blocks of... (more) |
— | over 9 years ago |
| Answer | — |
A: Best practices for maintaining documented code examples? ReadTheDocs (a popular system for documenting code-bases) has an interesting feature which may provide an answer to this question: literalinclude. With this directive, one can include code examples from another file within the documentation. The particularly interesting part is that a subset of line... (more) |
— | over 9 years ago |