Backslash escapes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 iv Contents Inline formatting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Emphasis . . . . 97 Automatic links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Inline links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Reference links --reference-links[=true|false] Use reference-style links, rather than inline links, in writing Markdown or reStructuredText. By default inline links are used. The place- ment of link references is affected by

Specifically, a header should have header guards and include all other headers it needs. If a template or inline function is declared in a .h file, that same header should provide its definition. The definitions a header. 5 Inline Functions Define functions inline only when they are small, say, 10 lines or fewer. You can declare functions in a way that allows the compiler to expand them inline rather than calling function can generate more efficient object code, as long as the inlined function is small. Feel free to inline accessors and mutators, and other short, performance-critical functions. Overuse of inlining can

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 5.5. Using inline icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . include line. 4 3. Text formatting 3.1. Quoted Text Words and phrases can be formatted by enclosing inline text with quote characters: Emphasized text Word phrases enclosed in 'single quote characters' in this case the enclosed text is rendered literally and is not subject to further expansion (see inline literal passthrough). ‘Single quoted text’ Phrases enclosed with a `single grave accent to the

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 3.4. Using inline icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . include line. 6 3. Text formatting 3.1. Quoted Text Words and phrases can be formatted by enclosing inline text with quote characters: Emphasized text Word phrases enclosed in 'single quote characters' in this case the enclosed text is rendered literally and is not subject to further expansion (see inline literal passthrough). ‘Single quoted text’ Phrases enclosed with a `single grave accent to the

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 3.4. Using inline icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . include line. 6 3. Text formatting 3.1. Quoted Text Words and phrases can be formatted by enclosing inline text with quote characters: Emphasized text Word phrases enclosed in 'single quote characters' in this case the enclosed text is rendered literally and is not subject to further expansion (see inline literal passthrough). ‘Single quoted text’ Phrases enclosed with a `single grave accent to the

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 3.4. Using inline icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . include line. 6 3. Text formatting 3.1. Quoted Text Words and phrases can be formatted by enclosing inline text with quote characters: Emphasized text Word phrases enclosed in 'single quote characters' in this case the enclosed text is rendered literally and is not subject to further expansion (see inline literal passthrough). ‘Single quoted text’ Phrases enclosed with a `single grave accent to the

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 3.4. Using inline icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . include line. 6 3. Text formatting 3.1. Quoted Text Words and phrases can be formatted by enclosing inline text with quote characters: Emphasized text Word phrases enclosed in 'single quote characters' in this case the enclosed text is rendered literally and is not subject to further expansion (see inline literal passthrough). ‘Single quoted text’ Phrases enclosed with a `single grave accent to the

engineering documentation that ranges from terse com- ments to detailed prose: 1. Inline comments: The primary purpose of inline comments is to provide information that the code itself cannot contain, such that’s relevant to a developer’s understanding of how to use the method. “Why” explanations are for inline comments. Think in prac- tical terms when writing method documentation: “This is a hammer. You use

message (with the comments and diff stripped out). Alternatively, you can type your commit message inline with the commit command by specifying it after a -m flag, like this: $ git commit -m "Story 182: conflict markers, not only giving you the “ours” and “theirs” versions, but also the “base” version inline to give you more context. $ git checkout --conflict=diff3 hello.rb Once we run that, the file will snapshot appropriately: puts 'deleteall' Dir.glob("**/*").each do |file| next if !File.file?(file) inline_data(file) end Note: Because many systems think of their revisions as changes from one commit to

message (with the comments and diff stripped out). Alternatively, you can type your commit message inline with the commit command by specifying it after a -m flag, like this: $ git commit -m "Story 182: conflict markers, not only giving you the “ours” and “theirs” versions, but also the “base” version inline to give you more context. $ git checkout --conflict=diff3 hello.rb Once we run that, the file will snapshot appropriately: puts 'deleteall' Dir.glob("**/*").each do |file| next if !File.file?(file) inline_data(file) end Note: Because many systems think of their revisions as changes from one commit to