Skip to content

doc: format exponents better

Rodrigo Muino Tomonari requested to merge github/fork/tniessen/doc-format-exponents into master

The 2^n notation is common in mathematics, but even then it often requires parentheses or braces. In JavaScript and C++, the ^ operator stands for bitwise xor, and should be avoided in the docs. In code tags, the JavaScript operator ** can be used. Otherwise, the sup tag can be used for formatting.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

Merge request reports