Writing Stack Exchange
Writing Stack Exchange

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.

This tag should be used for questions about how to represent programming constructs in prose, such as when including programming code in your .

You may also be interested in the tags , and . You should also mention whether you are following style guides, such as .

10 questions
7
votes
4 answers

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 shown below as expected. What I'm unsure of, though, is the…
TheProgrammer
  • 196
  • 6
6
votes
1 answer

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 code snippets in Scrivener so they look nice.…
adamasan
  • 163
  • 1
  • 5
3
votes
1 answer

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 in a newspaper, how would I write it? Is the…
Carl Roberts
  • 131
  • 2
2
votes
1 answer

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 usually-ignored issue of whether readers can use…
Flimzy
  • 201
  • 1
  • 2
  • 8
2
votes
1 answer

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. Can I still need copyright clearance for using…
Vishi
  • 21
  • 1
1
vote
5 answers

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 and becoming unable to continue. It is the same…
Kevin-Duel Trimble
  • 113
  • 3
1
vote
1 answer

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 tool do they write in? The only thing I can…
MathStat2718
  • 11
  • 1
1
vote
1 answer

How do I teach my protagonist high level programming?

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 actually hack a computer so he needs to learn it.…
Strawberry
  • 13
  • 4
0
votes
1 answer

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 code. The audience that this essay is going to be…
Officer Erik 1K-88
  • 3
  • 3
0
votes
1 answer

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 to denote the passage of time. Examples: If you…
user90726
  • 129
  • 6