Add big O notation to the style guide (#1261)

hugovk · web-flow · commit d4552d0942d5 · 2024-01-14T19:21:49.000+02:00
Co-authored-by: Hugo van Kemenade &lt;hugovk@users.noreply.github.com&gt;
diff --git a/documentation/style-guide.rst b/documentation/style-guide.rst
@@ -225,3 +225,20 @@ errors ("I made a mistake, therefore the docs must be wrong ...").  Typically,
 the documentation wasn't consulted until after the error was made.  It is
 unfortunate, but typically no documentation edit would have saved the user from
 making false assumptions about the language ("I was surprised by ...").
+
+Big *O* notation
+================
+
+Big *O* notation is used to describe the performance of algorithms.
+
+Use italics for the big *O* and variables. For example:
+
+======================== ====================
+reStructuredText         Rendered
+======================== ====================
+``*O*\ (1)``             *O*\ (1)
+``*O*\ (log *n*)``       *O*\ (log *n*)
+``*O*\ (*n*)``           *O*\ (*n*)
+``*O*\ (*n* log *n*)``   *O*\ (*n* log *n*)
+``*O*\ (*n*\ :sup:`2`)`` *O*\ (*n*\ :sup:`2`)
+======================== ====================
