Questions tagged [programming]
This tag should be used for questions about how to represent programming constructs in prose, such as when including programming code in your academic writing. It is NOT for help with programming problems; such questions belong on Stack Overflow.
10 questions
7 votes
4 answers
2k views
How should I designate a break in a sentence to display a code segment?
I'm writing some documents with embedded code listings. I reference such listings many times using something to the effect of, "...we provide an example as follows", with the block of code ...
- 196
1 vote
5 answers
269 views
Combatting crippling perfectionism
I am attempting to begin writing a Substack newsletter, but I have hit a serious problem: I am a chronic, crippled perfectionist. I can't get through a sentence of any given post without freezing up ...
0 votes
1 answer
171 views
How simple or detailed should be put into describing program code in a essay?
I am writing an essay about a problem that I had in a program that I was creating, of course, I managed to fix the problem, but I am wondering how much detail I should put into describing the actual ...
1 vote
1 answer
124 views
Writing a book containing ordinary text, python code and mathematical formulas - what tool to use?
I want to write a book containing ordinary text, python code, mathematical formulas and also pictures/plots. In general, how would this be done in the best way? People who publish books, how / in what ...
- 11
0 votes
1 answer
299 views
When vs. If vs. In situation where
An excerpt from Microsoft Writing Style Guide, which I'm trying to follow: Use if to express a condition, use whether to express uncertainty, and use when for situations that require preparation or ...
- 129
2 votes
1 answer
105 views
How to include a software license covering code samples in a book
I'm working on a programming book, which will be distributed both electronically and (potentially) in print. It includes many coding samples, which readers may wish to use. To avoid the hairy, and ...
- 201
1 vote
1 answer
172 views
How do I teach my protagonist high level programming? [closed]
I am working on a science fiction story about robots and the protagonists needs to hack the main computer to stop the robots. Edit: The protagonist knows a little bit of programming but not enough to ...
- 13
2 votes
1 answer
86 views
Copyright related issue on publishing a technical book?
I am preparing to publish a technical book on programming that contains figures and charts (like, compiler, linker, ASCII table, keywords list) created by myself by taking references from many sources....
- 21
6 votes
1 answer
4k views
How do I insert programming code snippets within Scrivener?
I'm trying out Scrivener, as I intend to write some technical material. I'm a Software Developer and what I intend to write is programming related. I still wasn't able to figure out how can I insert ...
- 163
3 votes
1 answer
240 views
How to quote programming code in AP Style?
I would like to put the following code in an article that is written in AP Style: puts 'Hello, world!' How do I do this? If I were to put the code (C++, Ruby, whatever) in an article that was written ...
- 131