StarMirror/CppCoreGuidelines
1
0
Fork 0
mirror of https://github.com/isocpp/CppCoreGuidelines.git synced 2024-03-22 13:30:58 +08:00
Code Issues Projects Releases Wiki Activity
508 Commits 14 Branches 4 Tags 216 MiB
105ff97910
Commit Graph

404 Commits

Author SHA1 Message Date
Gabriel Dos Reis
ca107da14c Merge pull request #279 from fkaelberer/patch-2 
Fix ES.103 example
 2015-10-04 11:20:07 -07:00
Gabriel Dos Reis
620eda5c3c Merge pull request #281 from fkaelberer/patch-3 
Fix minor typos and spacing
 2015-10-04 11:17:51 -07:00
Eliyahu Ravuna
78581f2ae6 std::chrono::duration example for I.4 
Make interfaces precisely and strongly typed.
 2015-10-04 20:12:10 +03:00
Felix Kälberer
56c319d46a Fix minor typos and spacing 2015-10-03 18:55:07 +02:00
Felix Kälberer
1de6e77b15 Fix ES.103 example 
```
    int area(int h, int w) { return h*w; }
    auto a = area(10'000'000 * 100'000'000);	// bad
```
The `*` in the second line should be a comma
 2015-10-03 16:47:24 +02:00
Thibault Kruse
d458c57d08 fix duplicate anchor IDs 2015-10-02 18:08:46 +02:00
Thibault Kruse
b5d8ef8be7 Fix missing lines/ bad indent 2015-10-02 17:42:28 +02:00
Eliyahu Ravuna
8050963a06 Access memory predictably - Revised according to the feedback in #256 
Capitalization revised according to the feedback in #256.
(Access memory predictably)
 2015-10-02 16:13:59 +03:00
Gabriel Dos Reis
57d06f2138 Merge pull request #261 from Eliyahu-Ravuna/patch-8 
As agreed in #255, commits squashed (ES.100)
 2015-10-02 06:05:42 -07:00
Eliyahu Ravuna
c4b3b8b0c6 As agreed in #255, commits squashed (ES.100) 
As agreed in #255, two commits squashed.
(ES.100: Don't mix signed and unsigned arithmetic)
 2015-10-02 16:02:20 +03:00
Eliyahu Ravuna
ad3d1dc631 Change agreed in #253 
As agreed in #253, three commits squashed into one.
(Suggested 'return containers by value' example + Title made more concise)
 2015-10-02 15:55:31 +03:00
Gabriel Dos Reis
4d1c32f298 Merge pull request #219 from tkruse/mdast-idempot 
Achieve mdast idempotency (4-space markdown indent, single empty lines)
 2015-10-02 03:37:36 -07:00
Gabriel Dos Reis
149a681188 Fix forward links in NL 
Fix #241.
 2015-10-02 03:31:10 -07:00
Thibault Kruse
d844553169 Code blocks consistently use 4 spaces markdown indent (via mdast) 
Exception is 8space indent for code inside bullet lists (also handled by mdast)
Changes code fences as well to 4-space indent.

This does not affect C++ indent within code blocks (mdast does not touch that either way).
 2015-10-02 12:17:40 +02:00
Thibault Kruse
e291947e25 fix consecutive blank lines (mdast output). 2015-10-02 12:17:04 +02:00
Gabriel Dos Reis
00d542f777 Fix misplaced override specifier 
Fixed #248.
 2015-10-02 03:12:47 -07:00
Gabriel Dos Reis
c4088e053b Merge pull request #237 from david-mitchell/patch-1 
Fix grammar.
 2015-10-02 03:04:10 -07:00
Gabriel Dos Reis
bdc863dcda Merge pull request #258 from axelstudios/master 
Fixed minor typos
 2015-10-02 02:54:48 -07:00
Gabriel Dos Reis
2536585830 Merge pull request #257 from RicoAntonioFelix/master 
Added capture in lambda expression...
 2015-10-02 02:54:00 -07:00
Gabriel Dos Reis
a615bdeb19 Merge pull request #254 from Eliyahu-Ravuna/patch-3 
Typo fixed in 'Use templates to express containers'
 2015-10-02 02:52:27 -07:00
Alex Swindler
23b1257817 Fixed minor typos 2015-10-01 21:12:20 -06:00
RicoAntonioFelix
af18193511 Added capture in lambda expression... 2015-10-01 21:32:09 -04:00
drusk
80f93640ce Fixed minor typo in section P.2. 2015-10-01 16:08:39 -07:00
Eliyahu Ravuna
6dbcabc974 Typo fixed in 'Use templates to express containers' 2015-10-02 00:47:39 +03:00
Gabriel Dos Reis
1ab6344b44 Merge pull request #218 from Jiwan/Jiwan-change-nullptr-passing-exemple 
Fixed minor error in I.12: Declare a pointer that must not be null as not_nul
 2015-10-01 03:14:00 -07:00
Gabriel Dos Reis
6746027209 Merge pull request #242 from tkruse/fix-minisections 
Replace **strong** fake headers with real markdown headers
 2015-10-01 03:11:02 -07:00
spacewander
9d4a7627c7 fix C.over index error 2015-10-01 17:56:02 +08:00
Thibault Kruse
e4ea6c5374 Replace **strong** fake headers with real markdown headers carrying section semantics 2015-09-30 22:26:44 +02:00
Thibault Kruse
d5295a8d9d Fix broken and fragile rendering of Bibliography 2015-09-30 20:36:03 +02:00
Thibault Kruse
4b1f9ad99c fix missing closing parens (in test()) 2015-09-30 20:36:03 +02:00
David Mitchell
3d3d43d60f Fix grammar. 2015-09-30 10:18:58 -07:00
David Mitchell
d8f54449d6 Fix typo. 2015-09-30 10:02:48 -07:00
Jiwan
e41b65cca1 Fixed a minor error in an example in I.12. 2015-09-30 15:33:25 +02:00
Emmanuel Briot
cc45432b01 Minor typo fixes 2015-09-30 12:05:07 +02:00
Gabriel Dos Reis
812fb8f314 Merge pull request #221 from david-mitchell/patch-9 
Fix typo.
 2015-09-29 17:43:43 -07:00
Gabriel Dos Reis
b7940d2ef4 Merge pull request #220 from david-mitchell/patch-8 
Fix typo.
 2015-09-29 17:43:13 -07:00
Gabriel Dos Reis
a39f61bc5c Merge pull request #223 from delta-nry/patch-1 
Correct and clarify FAQ.59 and FAQ.60
 2015-09-29 17:42:35 -07:00
Gabriel Dos Reis
cedd9c6481 Merge pull request #209 from jlaire/typos-and-other-fixes 
Typos and other fixes
 2015-09-29 17:40:02 -07:00
Gabriel Dos Reis
d3d0426b39 Merge pull request #228 from david-mitchell/patch-10 
Fix verb agreement.
 2015-09-29 17:32:05 -07:00
Gabriel Dos Reis
b8c9ad47ac Merge pull request #230 from david-mitchell/patch-12 
Fix awkward wording.
 2015-09-29 17:31:17 -07:00
David Mitchell
7103785b20 Fix awkward wording. 2015-09-29 16:55:56 -07:00
David Mitchell
7d82c95191 Add missing punctuation. 2015-09-29 16:50:55 -07:00
David Mitchell
5560508b28 Fix verb agreement. 2015-09-29 16:48:24 -07:00
Johannes Laire
3f160967b6 More small fixes 2015-09-30 00:42:58 +02:00
Johannes Laire
74b5debe8c Add an example 2015-09-30 00:42:27 +02:00
Johannes Laire
9a976c8a85 Fix bugs in examples 2015-09-30 00:42:27 +02:00
Johannes Laire
d01a414fed Typo fixes 2015-09-30 00:42:27 +02:00
Johannes Laire
7e6734ade4 Small fixes to markdown formatting 2015-09-30 00:41:38 +02:00
Nathan Yee
4befe68ea6 Correct and clarify FAQ.59 and FAQ.60 2015-09-29 15:35:38 -07:00
David Mitchell
e1810cf164 Fix typo. 2015-09-29 14:57:08 -07:00
David Mitchell
632e4ef544 Fix typo. 2015-09-29 14:55:43 -07:00
Herb Sutter
8a1d622671 Added dyn_array vs. dynarray to FAQ 2015-09-29 09:09:38 -07:00
Brian Rodriguez
7112881429 T.40 typo: find to find_if 
`std::find` accepts a value, not a function object.  `std::find_if` was the intended function.
 2015-09-29 12:06:21 -04:00
Gabriel Dos Reis
1ad595e1a6 Merge pull request #212 from tkruse/fix-mdstyle12 
Fix code snippets that do not compile, or mark them with ???
 2015-09-29 09:03:38 -07:00
Herb Sutter
474d0d3e6b Elaborated on some of the FAQs 2015-09-29 09:01:29 -07:00
Thibault Kruse
314cff005c Fix code snippets that do not compile, or mark them with at least one ??? 2015-09-29 17:57:48 +02:00
Herb Sutter
2528acd017 Added GSL type-specific FAQs 2015-09-29 08:55:09 -07:00
Gabriel Dos Reis
8a1ff8bb3c Merge pull request #196 from david-mitchell/patch-4 
Fix typo.
 2015-09-29 08:51:21 -07:00
Gabriel Dos Reis
16a332330c Merge pull request #197 from david-mitchell/patch-5 
Improve wording and structure of paragraph.
 2015-09-29 08:50:06 -07:00
Gabriel Dos Reis
7fa4b587b1 Merge pull request #201 from jwakely/patch-2 
Change gsl:: qualification to lowercase
 2015-09-29 08:45:04 -07:00
Gabriel Dos Reis
48c3c3b549 Merge pull request #211 from tkruse/fix-mdstyle11 
fix bad mix of tabs and spaces
 2015-09-29 08:41:29 -07:00
Thibault Kruse
4b0c6702bb fix bad mix of tabs and spaces 2015-09-29 11:44:07 +02:00
Thibault Kruse
5a449f4bd8 bad char instead of minus 2015-09-29 11:39:22 +02:00
Thibault Kruse
33f832e090 typo 2015-09-29 11:39:22 +02:00
Thibault Kruse
fca180e978 Fix code that does not compile 2015-09-29 11:39:22 +02:00
Thibault Kruse
a4c8444032 Minor fix: remove blank inside html tags 2015-09-29 11:39:22 +02:00
Gabriel Dos Reis
93736f8e41 Merge pull request #137 from trebconnell/final_action 
Change casing of Final_action to final_action
 2015-09-29 02:19:00 -07:00
Gabriel Dos Reis
1a3b28260f Merge pull request #207 from tryfinally/patch-2 
typo fixes: constxp -> constexpr, spaces
 2015-09-29 02:15:12 -07:00
Gabriel Dos Reis
5302819df0 Merge pull request #188 from tkruse/fix-mdstyle7 
Some style issues
 2015-09-29 02:14:20 -07:00
rkawulak
7e4a683c96 Lots of minor fixes (typos, code errors, formatting, etc.) 2015-09-29 10:35:26 +02:00
Muhammad Zahalqa
45ff180fde typo fixes 
ES.45
 2015-09-29 10:24:15 +03:00
Thibault Kruse
95ed869751 fix: code within bullets must be indented 8 spaces 
See http://meta.stackexchange.com/questions/3792/how-to-nest-code-within-a-list-using-markdown
 2015-09-29 09:16:10 +02:00
Thibault Kruse
946ffee133 fix bad code indentation 2015-09-29 09:15:39 +02:00
Thibault Kruse
56db9e88a4 minor markdown style fixes 2015-09-29 09:15:39 +02:00
Thibault Kruse
5ac1676b10 Remove trailing whitespace, as it can be unintentionally interpreted as meaningful after bullet lists 2015-09-29 09:15:13 +02:00
Gabriel Dos Reis
f34bc55c73 Merge pull request #194 from tkruse/fix-mdstyle8 
Fix markdwn issues that confuse mdast markdown linter
 2015-09-28 23:58:13 -07:00
Gabriel Dos Reis
7c4b526325 Merge pull request #199 from david-mitchell/patch-7 
Fix typo.
 2015-09-28 23:56:03 -07:00
Johannes Laire
4bea8b4573 Fix typo 2015-09-29 08:36:37 +02:00
Thibault Kruse
777f7bc5fb fix code blocks indented with tab (4 spaces instead) 2015-09-29 01:44:26 +02:00
Thibault Kruse
8adf569a57 Fix style issues that confuse the mdast linter (and need to be fixed anyways) 2015-09-29 01:44:26 +02:00
Treb Connell
462590319a Merge branch 'master' of https://github.com/isocpp/CppCoreGuidelines into final_action 
Conflicts:
	CppCoreGuidelines.md
 2015-09-28 15:23:12 -07:00
Treb Connell
04637619de Change 'finally object' to 'final_action object' 2015-09-28 15:20:19 -07:00
Herb Sutter
4b6fb49772 Added a FAQ section 2015-09-28 12:32:50 -07:00
Jonathan Wakely
53dc924649 Change gsl:: qualification to lowercase 2015-09-28 19:36:07 +01:00
David Mitchell
d7f7ca5ab4 Fix typo. 2015-09-28 10:23:19 -07:00
David Mitchell
46e867e9c6 Improve wording and structure of paragraph. 
To be grammatically correct, the phrase "Confusion about what meaning a T* is the source" should have had a doubled "is", which would have been awkward, so the sentence has been reworded.

The second and third sentences were inverted. Prior to the inversion, the sentence starting with "For example" initially appeared to be expanding on the debuggability of not_null, rather than providing an example of how using separate names improves code quality.
 2015-09-28 09:54:11 -07:00
David Mitchell
aad584c8b1 Fix typo. 2015-09-28 09:16:20 -07:00
Thibault Kruse
a7dc7d1fa6 Put header-anchors in header. For Compliance, correctness, consistency 
The anchor would else point to the end of the previous section
Also this causes issues with tools ensuring a blank line before a header.
 2015-09-28 10:10:42 +02:00
Thibault Kruse
35161a3d04 Consistent Space between anchor and header 2015-09-27 21:45:30 +02:00
Thibault Kruse
7b422eac3f fix header inside anchor 2015-09-27 21:45:14 +02:00
Thibault Kruse
12db7f8757 Fix html anchors for links 2015-09-27 21:44:42 +02:00
Thibault Kruse
78b66f4eae Obsolete question marks 2015-09-27 21:04:32 +02:00
Thibault Kruse
452f587a4d bad indentation, mark missing example with ??? 2015-09-27 21:04:32 +02:00
Thibault Kruse
c2266bd8e4 fix bad indentation, causes bullet list to become code block 2015-09-27 21:04:32 +02:00
Thibault Kruse
411a5749e4 typos 2015-09-27 21:04:32 +02:00
Thibault Kruse
104d2327d5 fix markdown style 2015-09-27 21:04:32 +02:00
Gabriel Dos Reis
4f76723995 Merge pull request #155 from tkruse/fix-mdstyle5 
Fix typos and minor style problems
 2015-09-27 11:55:34 -07:00
Thibault Kruse
a68ace40df use markdown link instead of html link 2015-09-27 20:48:09 +02:00
Thibault Kruse
7c0d7830e2 typos 
Conflicts:
	CppCoreGuidelines.md
 2015-09-27 20:48:09 +02:00
Thibault Kruse
90b62edaf0 Ambiguous indentation within unordered list 2015-09-27 20:47:15 +02:00
Thibault Kruse
0855efaa1d fix mixup of indentation strategies inside same codeblocks 2015-09-27 20:46:07 +02:00
Gabriel Dos Reis
1e49b7b7a3 Merge pull request #174 from tkruse/fix-mdstyle3 
Fix minor style issues around bullet lists and Enforcement sections
 2015-09-27 11:04:26 -07:00
Gabriel Dos Reis
e4b961394c Merge pull request #160 from certik/number_fix 
Fix numbers in sections to be consistent with TOC
 2015-09-27 10:58:42 -07:00
Thibault Kruse
c4f09f2d19 Fix / Consistent Enforcement sections 2015-09-27 19:37:29 +02:00
Thibault Kruse
7f20741f38 Fix missing / bad indent or style within bullet list 2015-09-27 19:34:00 +02:00
Thibault Kruse
d2ea0766b0 make headlines within list 1st level list (else they are prone to be part of earlier bullet 2015-09-27 19:32:34 +02:00
Gabriel Dos Reis
07ae55a037 Merge pull request #164 from tkruse/fix-mdstyle6 
Fix mdstyle6
 2015-09-27 10:02:14 -07:00
Gabriel Dos Reis
521200397e Merge pull request #165 from tkruse/links-without-spaces 
Fix: Consistently name anchors for links without spaces
 2015-09-27 09:59:04 -07:00
Gabriel Dos Reis
12ee68f8d2 Merge pull request #171 from RicoAntonioFelix/master 
Corrected typographical errors...
 2015-09-27 09:56:52 -07:00
Thibault Kruse
b2a4132cf2 Fix / Consistent Enforcement sections 2015-09-27 18:55:53 +02:00
Thibault Kruse
c83bdc5495 fix double hash and missing Discussion 2015-09-27 18:55:52 +02:00
Thibault Kruse
8b0460d899 remove bad chars 2015-09-27 18:55:41 +02:00
Thibault Kruse
cc492c1e56 add missing ??? 2015-09-27 18:55:30 +02:00
Thibault Kruse
cb4ee8e286 Fix: Consistently name anchors for links without spaces 2015-09-27 18:53:26 +02:00
Gabriel Dos Reis
f2c4d1459c Merge pull request #162 from tkruse/fix-biblio 
fix citations/references/bibliography.
 2015-09-27 09:46:46 -07:00
Gabriel Dos Reis
ca57720e30 Merge pull request #161 from tkruse/fix-comma 
fix blank after comma
 2015-09-27 09:44:35 -07:00
Gabriel Dos Reis
3c3b204b75 Merge pull request #163 from tkruse/fix-anchors 
Markdown fix anchors and move Header text outside anchor
 2015-09-27 09:39:49 -07:00
Gabriel Dos Reis
1b944fade2 Merge pull request #166 from tryfinally/patch-1 
typo fix: ES.5 + ES.6 retension -> retention
 2015-09-27 09:36:12 -07:00
Gabriel Dos Reis
4f7b740d94 Merge pull request #168 from tkruse/fix-backtick 
add missing backticks
 2015-09-27 09:35:00 -07:00
Mikhail Maltsev
4bc790c522 Indent some code examples for correct rendering 2015-09-27 19:14:13 +03:00
RicoAntonioFelix
a2473a5c69 Corrected typographical error... 2015-09-27 11:46:30 -04:00
RicoAntonioFelix
1652fb6d56 Corrected typographical error... 2015-09-27 11:28:54 -04:00
Thibault Kruse
46e313c256 add missing backticks (breaks formatting else because of underscore in std::memory_order) 2015-09-27 13:56:22 +02:00
Muhammad Zahalqa
c9b7b8aa06 typo fix: ES.5 + ES.6 retension -> retention 
renesion usually applied to magnetic tapes.
 2015-09-27 12:46:24 +03:00
Thibault Kruse
758f3101fc Markdown fix anchors: Move Header text outside anchor, else header becomes an ugly noop link (also for Consistency) 2015-09-27 10:00:49 +02:00
Thibault Kruse
18bd7f3c92 fix citations/references/bibliography. 2015-09-27 09:59:59 +02:00
Thibault Kruse
e558cf9919 fix blank after comma 2015-09-27 09:56:42 +02:00
Ondřej Čertík
88e881c197 Fix numbers in sections to be consistent with TOC 
The sections R.24, R.30 - R.37 had incorrect numbers in the text. Also R.30 was
after R.31. This is now fixed.
 2015-09-26 19:17:22 -06:00
Andrew Pardoe
2a50e98a19 Addressed issue #123 2015-09-26 18:13:22 -07:00
Andrew Pardoe
bb95e9839d Addressing issue #51 2015-09-26 18:10:54 -07:00
Piotr Padlewski
b8e9216bca Update CppCoreGuidelines.md 
Destructors are always marked as noexcept (unless noexcept(false)) using this word here is ambigious.
 2015-09-26 15:46:41 -07:00
Gabriel Dos Reis
572119b71d Merge pull request #157 from prazek/patch-1 
Update CppCoreGuidelines.md
 2015-09-26 15:11:44 -07:00
Egor Pugin
9222fd1b1f Fix typo. 2015-09-26 14:00:52 +03:00
Egor Pugin
240bc0ea0c Private constructor does not allow to create derived classes. 2015-09-26 13:59:26 +03:00
Gabriel Dos Reis
bf8f1b8f49 Merge pull request #139 from trebconnell/fixtypos 
Fix typos
 2015-09-26 00:57:45 -07:00
Gabriel Dos Reis
9e25b93a18 Merge pull request #148 from RicoAntonioFelix/master 
Minor fixes to clean up the document...
 2015-09-26 00:46:47 -07:00
Piotr Padlewski
4ad6d50f86 Update CppCoreGuidelines.md 2015-09-26 00:36:35 -07:00
Evan Teran
e508837f42 Correcting minor typo 2015-09-26 00:05:15 -04:00
RicoAntonioFelix
c7a820e219 Corrected spelling error... 2015-09-25 22:20:40 -04:00
RicoAntonioFelix
eef63f5188 Capitalize for consistency... 2015-09-25 22:16:53 -04:00
RicoAntonioFelix
d43d484417 Remove extra backtick... 2015-09-25 22:02:05 -04:00
Andrew Pardoe
c813800c1a Addressing issue #68 2015-09-25 13:06:19 -07:00
Treb Connell
8eb26fc8dd Fix typos. I don't think these are fixed by other PR's 2015-09-25 11:56:51 -07:00
Treb Connell
43051d1fc8 fix a case of Finally 2015-09-25 11:53:46 -07:00
Treb Connell
dffb544a2c change casing of 'Final_action' to 'final_action' 2015-09-25 11:51:29 -07:00
Andrew Pardoe
3926ebbf72 Merge branch 'master' of https://github.com/isocpp/CppCoreGuidelines 2015-09-25 11:39:22 -07:00
Andrew Pardoe
1d9be95ee0 Added alternative fix for PR #132 2015-09-25 11:38:54 -07:00
Andrew Pardoe
6127598008 Merge pull request #121 from jfultz/patch-1 
Fix usage of non_null in zstring clause.
 2015-09-25 11:31:37 -07:00
Andrew Pardoe
033059103d Add fix from issue #122 2015-09-25 11:16:51 -07:00
Gabriel Dos Reis
0599a69d4a Merge pull request #127 from frutiger/fixes-broken-links 
CppCoreGuidelines.md: fixes broken links.
 2015-09-24 22:56:32 -07:00