Skip to content

Style Guide#

Work in progress

This style guide is a work in progress.

Motivate concepts through questions and examples#

“In Mathematics the art of proposing a question must be held of higher value than solving it.”
— Georg Cantor

“It is not the answer that enlightens, but the question.”
— Eugène Ionesco

Explain in a simple, clear, and concise way#

“Make things as simple as possible, but not simpler.”
— Albert Einstein

Zen of Python

Beautiful is better than ugly.
Explicit is better than implicit.
Simple is better than complex.
Complex is better than complicated…

Involve the reader in the discussion#

  • Write in second person.
  • Include figures and illustrations.
  • Use a conversational tone. Make the content friendly and inviting.
  • It’s alright to use contractions.
  • Active voice is preferred over passive voice.
Last update: April 2, 2021