Tag Info

Hot answers tagged

5

In my opinion, any answer looks messy. One "sentence" with capitals halfway through bugs me; so does a line starting without a capital. Personally, I would restructure the entire thing to avoid the issue entirely: Example 1 Currently, line 57 of camera.py looks like this: camera.start_recording('foo.h264', quantization=25) In this line, the ...


2

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 lines can be extracted from the source file via the :lines: ...


2

Often there is a difference between a thesis, as it is submitted to the examination board, and the book, as it is published. The version that you submit to the board of examiners must comply with the academic rules of your discipline. It will usually be written for an audience of experts. Ph.D. theses have to be published, but today you can publish it ...


1

I approach code in text in the same way I approach dialogue: the code is a quotation from another "speaker", so I set it off from the surrounding text. Since it is not spoken language, I do not use the conventions for spoken language (same font, quotation marks, etc.), so as to cause no confusion, but the conventions for displaying code (monospaced font, ...


1

I am not specifically familiar with that book, but as much as I hate to admit it (I am not fond of microsoft) they tend to do these things well. The two pieces advice I would give you are to supplement with a traditional style guide like Chicago, and document where you draw each standard from; and to feel free to set your own style for things where the style ...



Only top voted, non community-wiki answers of a minimum length are eligible