Timeline for How to structure a sentence containing long code examples?
Current License: CC BY-SA 3.0
6 events
| when toggle format | what | by | license | comment | |
|---|---|---|---|---|---|
| Sep 14, 2017 at 20:13 | comment | added | user | I feel example 1 is better than example 2, because example 1 actually points out the specific difference. In this case it's tolerably clear even without that, but other cases might not be as clear cut. Highlighting the difference aids in interpretation of the text. | |
| Mar 18, 2015 at 14:11 | comment | added | Watercleave | @DaveJones Glad I could help. | |
| Mar 18, 2015 at 12:01 | vote | accept | Dave Jones | ||
| Mar 18, 2015 at 12:00 | comment | added | Dave Jones | I've just finished re-writing the deprecation chapter according to example 1, and I'm absolutely sold on it (even more than I was before). The fact it affords the opportunity to explicitly state (or reiterate) the action to be taken immediately before the "new" snippet is particularly nice, and the new version of the text feels much better to me. Thank you! | |
| Mar 18, 2015 at 1:06 | comment | added | Dave Jones | I like your second solution, but I'm in a bit of a quandry here. Were I writing for experienced devs I would happily use a patch format for this on the basis that any experienced dev would be happy to interpret it. However, this specific project, picamera, has an educational thrust and needs to be understandable by all experience levels. For that reason I suspect your first solution is preferable in this case. Specifically, this question was to do with the deprecation chapter | |
| Mar 17, 2015 at 21:05 | history | answered | Watercleave | CC BY-SA 3.0 |