Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document what our macros do and when to use them #327

Open
zygoloid opened this issue Jun 18, 2014 · 3 comments
Open

document what our macros do and when to use them #327

zygoloid opened this issue Jun 18, 2014 · 3 comments

Comments

@zygoloid
Copy link
Member

Document this on the wiki so everyone can keep track.

@zygoloid zygoloid changed the title document what our macros use and when to use them document what our macros do and when to use them Aug 31, 2014
@tkoeppe
Copy link
Contributor

tkoeppe commented Nov 11, 2014

Where do you want that documented? Inside macros.tex, or in a separate file?

@jwakely
Copy link
Member

jwakely commented Mar 20, 2016

WIP:

  • techterm -- used (inconsistently) in the library to introduce (and sometimes incorrectly to refer to) a technical term, e.g. "An \techterm{invalid} iterator is ..."
  • defnx -- used to introduce/define a technical term (so same as techterm?), adding an index entry for the second argument, e.g. "the \defnx{observable behavior}{behavior!observable} of the program"
  • defn -- Same as \defn, reusing the same text for the term and the index entry.
  • term -- similar to defn, but without an index entry (so maybe defn should be defined using term, not using textit directly).
  • grammarterm -- used in text/examples when referring to a grammar production from the formal C++ grammar, e.g. "the potential scope of the \grammarterm{using-directive} that follows"
  • placeholder -- a placeholder variable/type such as "Let i be ...", formatted in italics (or maybe math font, see issue placeholders should be formatted with math fonts #326)

@jwakely
Copy link
Member

jwakely commented Mar 20, 2016

WIP:

Use \bigoh for Big-O complexity requirements, e.g. \bigoh{log(N)}

Use \Cpp for "C++" (it has special rules to make it look nicer).

Use \range for a half-open range, e.g. \range{0}{N} => [0, N), and similarly \orange, \crange and \brange for open ranges, closed ranges, and "backwards" half-open (e.g. (first,last], as used for copy_backward) ranges, respectively.

@jwakely jwakely removed their assignment Mar 21, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants