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
1,694 Commits 14 Branches 4 Tags 216 MiB
35db3bf123
Commit Graph

1378 Commits

Author SHA1 Message Date
Jonathan Wakely
4af8321e91 Fix "an reasonable" typo 
Fixes #1211
 2018-05-15 15:25:23 +01:00
Gabriel Dos Reis
599fb02d12
Merge pull request #1208 from mabuchner/1207-cp-31-memory-corruption-from-example 
Pass parameter as reference in CP.31 example
 2018-05-14 11:10:24 -07:00
Sergey Zubkov
a866b000d3
it's deletion -> its deletion 2018-05-10 12:05:09 -04:00
Sergey Zubkov
4e58fb87f7
typo: "nothing to do with sync" -> "nothing to do with stdasync" 2018-05-08 08:46:51 -04:00
mbuchner
7261f5d2fb Pass parameter as reference in CP.31 example 
Fixes #1207.
 2018-05-08 09:25:01 +02:00
Gabriel Dos Reis
20d9f42674
Merge pull request #1198 from ianhattendorf/SL-str-12-cpp-14 
SL.str.12: s suffix is available in C++14
 2018-04-30 11:16:47 -07:00
Gabriel Dos Reis
046b2a0833
Merge pull request #1201 from mabuchner/1200-es-102-odd-loop-condition-in-second-example 
Fix ES.102 odd loop condition in example
 2018-04-30 11:15:32 -07:00
Gabriel Dos Reis
46ecdd6830
Merge pull request #1202 from gumb0/patch-1 
Remove unnecessary comments from C.42 examples
 2018-04-30 11:13:26 -07:00
Andrei Maiboroda
ff4a3069a1
Fix comments in C.42 examples 2018-04-25 18:27:19 +02:00
Andrei Maiboroda
2ee3fff631
Fix typo in C.44 2018-04-25 18:21:54 +02:00
Ian Hattendorf
d49c720e98 Fix typo in error handling intro 2018-04-20 16:12:32 +01:00
Ian Hattendorf
69d48f76c7 E.14 an->a is->are fixes 2018-04-20 16:12:32 +01:00
Ian Hattendorf
2cedd99f32 Remove whitespace at the end of lines 2018-04-20 16:12:32 +01:00
mbuchner
53c0bd2bd1 Fix ES.102 odd loop condition in example 2018-04-20 09:46:27 +02:00
Ian Hattendorf
ee64b7ec17
SL.str.12: s suffix is available in C++14 
std::literals::string_literals::operator""s is available since C++14
while std::pair class template argument deduction is available since
C++17
 2018-04-19 19:10:26 -07:00
hsutter
1e4dba2c0b Renamed NL.10 to "prefer underscore_style names" 2018-04-16 11:34:59 -07:00
hsutter
93ac723f6b Fixed rest of T.12 example following up #1189 2018-04-16 11:26:15 -07:00
Alexander “weej” Jones
15008e8432 Fix T.12's incorrect usage of vector::begin() (#1189) 2018-04-16 11:25:22 -07:00
hsutter
a5e28d4a61 Updated intro wording 2018-04-16 11:22:40 -07:00
Andrew Pardoe
b21b125d42 Capitalization error 2018-04-16 11:15:57 -07:00
hsutter
b3d2f853f7 Changed "method" to "function" in three places for consistency 2018-04-16 11:14:25 -07:00
hsutter
cea965f610 Reworded "consume" to "will-move-from" parameters 
To improve clarity since the wording was causing confusion
 2018-04-16 11:06:48 -07:00
Gabriel Dos Reis
99b997b6f0
Merge pull request #1179 from jwakely/issue-1177 
Fix comment to match code
 2018-04-09 11:17:13 -07:00
Chris Guzak
e5f28e4095 SF.11, Header files should be self-contained (#1181) 
* SF.11 Header files should be self-sufficient added

* PR feedback addressed

* explain more

* update reason baed on PR feedback

* add VS code dir to .gitignore

* more PR feedback
 2018-04-09 11:16:18 -07:00
Gabriel Dos Reis
85db0de16c
Merge pull request #1183 from beinhaerter/formatting 
Formatting in C.46
 2018-04-05 15:28:25 -07:00
Werner Henze
0cb724fe20 Fixed link for "avoid conversion operators" 2018-04-04 19:59:41 +02:00
Werner Henze
b724f71473 Formatting "explicit" as code 2018-04-04 19:53:07 +02:00
Jason Mercer
c0264f3831 fixed scale factor for millimeters (#1182) 2018-04-03 15:01:57 -04:00
Jonathan Wakely
e721ee53cb Fix comment to match code 
Also fix missing references and add cross-reference to F.22.

Fixes #1177
 2018-03-27 12:16:21 +01:00
Jonathan Wakely
dbe8bf0207 Fix typo 
Fixes #1176
 2018-03-27 11:45:16 +01:00
Andrew Pardoe
9ac22abe0a Adding note suggested by @jwakely in #1165 2018-03-26 12:03:46 -07:00
Andrew Pardoe
b9fe28cc2a update date 2018-03-26 11:55:31 -07:00
Jonathan Wakely
ba25a26294 Rephrase C.21 to talk about declaring not defining (#1152) 
* Rephrase C.21 to talk about declaring not defining

Add examples.

Fixes #870.

* Define special functions, clarify default constructor effects
 2018-03-26 11:15:03 -07:00
fekir
ab5f9c18bd catch by reference in all samples (#1154) 2018-03-26 11:13:49 -07:00
Stephan Weller
2c3d9921b6 Replace erroneous public keyword by private in C.129. (#1166) 2018-03-26 11:13:11 -07:00
beinhaerter
edf13aabc0 Note that C.46 does not apply for copy/move ctors (#1169) 
* Note that C.46 does not apply for copy/move ctors

* moved Note section before Enforcement section
 2018-03-26 11:12:03 -07:00
Gabriel Dos Reis
644e0f5b5e
Merge pull request #1164 from ChrisGuzak/ChrisGuzak-sizeof-not_max 
use sizeof(buffer) instead of MAX
 2018-03-22 16:15:32 -07:00
echeij
6ed138076d Fixed get_string example in F.21 (#1160) 
In the 'all values as return value' example in F.21, the passed istream was not used in the function.
 2018-03-14 10:14:07 -04:00
Chris Guzak
373f4c4808
use sizeof(buffer) instead of MAX 2018-03-13 15:28:26 -07:00
nnaka
09035eb1e4 Align comment block (#1162) 2018-03-11 13:35:09 +00:00
nnaka
9c4d4247b1 P.5 example read int array size mismatch (#1161) 
Expand comment to clarify problem.
 2018-03-11 08:13:55 +00:00
Andrew Pardoe
b487f9790a subject-verb agreement in NL.2 2018-03-09 14:23:39 -08:00
hsutter
8d5d5e4aeb To address #1147 
Changed `.length()` to `.size()` for `span` examples to track
standardization changes.
 2018-03-05 10:51:31 -08:00
Andrew Pardoe
beed3e97c0 update date 2018-02-26 14:31:04 -08:00
Ari Hietanen
6c55d4eaaf Bug fix C4 class Foobar (#1143) 
* Fixed bug in example code of C4 Expecptions. In C4, the class function void Foobar::foo(double x) is supposed to call the overloaded void Foobar::foo(int x), but in the call foo(std::round(x)), std::round returns a double. Hence, it will get stuck in an infinite recursive loop. Added static_cast<int>(..) to enforce the call to right overload. Added also keyword public to be more consistent.

* Changed static_cast<int> to narrow_cast<int> following ES.46.

* Modified C4 Foobar class, s.t, std::lround(x) is now called in
void foo(double) and the overload is changed to void foo(long) from (int). Now there is
no need for conversions.
 2018-02-26 11:11:51 -08:00
Tobias Mende
da3b6b98bc Do Not Check For nullptr Explicitely In Examples (closes #1142) (#1144) 2018-02-26 11:09:45 -08:00
beinhaerter
9c98f9679c Copy-Paste-Typo in Comment for ES.87 sample (==0/!=0) (#1145) 2018-02-26 11:07:05 -08:00
hsutter
10c0a8b156 Closes #1119 
Make C.43 crisper -- the guideline is that default construction is
required for copyable types. A lot of the existing examples then just
fall out, without having to be presented as special cases. This was the
original intent and I think this new text helps make that clearer.
 2018-02-12 16:03:01 -08:00
Andrew Pardoe
d9f3149e11 Update references to C++17, also typo 2018-02-12 11:56:59 -08:00
Dipl.-Ing. Raoul Rubien, BSc
73dad7909d title page/In.sec: reordered and updated titles (#1135) 
* title page: updated titles and unified titles' camel case to sentence case

* In.sec: reordered bullets to match document's workflow, updated titles

* updated several links and link names, modified names to title case

* redirected broken link to new anchor Rf-value-return at 'value return sematic rules' block

* updated links

* reverted unindended broken artistic prose

* updated links, modified "see also's" formatting to comply with the majority

* modified "see also's" formatting to comply with the majority

* fix spellcheck: 'Componentization -> Compartmentalization'

* updated link name
 2018-02-12 11:12:58 -08:00
Bernardo Sulzbach
eb534411a7 Should say repository instead of depository (#1138) 2018-02-10 11:43:02 -08:00
Dipl.-Ing. Raoul Rubien, BSc
888067d6ff fixed spellcheck/lint issues on running make in ./scripts/ (#1134) 2018-01-24 08:12:05 -08:00
Sergey Zubkov
25d9d12e15 travis CI fixes 2018-01-24 09:19:47 -05:00
hsutter
f8f396ef3b Typo fix to NL.5 2018-01-23 12:03:41 -08:00
hsutter
c5f67599d1 Added another example to NL.5 2018-01-23 12:01:57 -08:00
hsutter
c10e5503e9 Closes #1104 2018-01-23 12:01:56 -08:00
Sergey Zubkov
e3f753ed14 the copy ctor typo and comment fixes from #1125 2018-01-23 14:19:11 -05:00
Andrew Pardoe
15ca9d220c Fixing typo per #1130 & updating date 2018-01-22 11:24:19 -08:00
Herb Sutter
c1e3cd01cd Add gsl::index, closes #1098 (#1115) 
* Add gsl::index, closes #1098

And update examples throughout to use `index` as appropriate

* Actually adding `index` to the GSL.util section

* Added `sizeof` to whitelisted signed/unsigned comparisons

Same reason as container `.size()` -- better backward compatibility with
the existing standard
 2018-01-22 11:16:11 -08:00
Oleg Artenii
b677b69014 Removed useless "Currently (July 2016)" (#1123) 
* Removed useless "Currently (July 2016)"

* replaced `GCC 6.1` with `GCC 6.1 or later`

* Correct usage of `and/or` in `GCC 6.1 _ later`
 2018-01-22 11:14:51 -08:00
rknuus
2bdd1ae705 add example for R.24 (#1127) 
* add example for R.24

taken from https://cpppatterns.com/patterns/weak-reference.html, where
it's published under CC0 Public Domain Dedication

* improve example for R.24
 2018-01-22 11:08:23 -08:00
Jonathan Wakely
5c3006b60f Change "untended" to "unintended" in C.9 2018-01-09 22:27:14 +00:00
Sergey Zubkov
59eb77027e travis CI fixes 2018-01-02 22:15:02 -05:00
Bjarne Stroustrup
8f87a03588 ES.87 
#1032 comment and example added.
To consider: should integer comparison be broken out as its own rule?
 2018-01-01 17:37:38 -05:00
Bjarne Stroustrup
72b9b40a7c Some examples in Per.11 
In response to #936 I added some text to Per.11. More would be welcome
 2018-01-01 15:47:20 -05:00
Bjarne Stroustrup
edbfc3b8ec Clarifying (I hope) text and example added 
addressing #980 and #9777
 2018-01-01 14:26:00 -05:00
Bjarne Stroustrup
0df2c26e9a C.129 
#1052 added Jonathan's example
 2018-01-01 13:56:34 -05:00
Bjarne Stroustrup
ff42e7bbaf closing #547 
(now?) we have CP.3 and CP.31. Also CP.mess.
Yes we need more work on CP.mess
 2018-01-01 11:44:58 -05:00
Bjarne Stroustrup
ecabc369bb simplifying ES.20 
#488
 2018-01-01 11:13:38 -05:00
Bjarne Stroustrup
7e5019378b Fix #493 array myth 
Added comment about performance to SL.con.1
 2018-01-01 10:40:45 -05:00
Andrew Pardoe
7cfb1d7961 update date 2017-12-26 08:13:24 -08:00
Mitch Phillips
bd948ee839 Fix example code in F.20. (#1109) 2017-12-22 16:01:42 -05:00
michaelz85
044a4b277e fixed anchor name for T.21 (#1108) 2017-12-20 11:50:46 -05:00
michaelz85
7c11ac1acf fixed a word (should be 'that' not 'the') (#1107) 2017-12-20 11:46:50 -05:00
michaelz85
b5a20f10ea fixed error in code comment (#1105) 2017-12-18 11:39:04 -05:00
Oleg Artenii
352e94babe fixed minor typo: "on the on the" -> "on the" (#1103) 2017-12-13 12:52:13 -05:00
Andrew Pardoe
d3a523eea8
Typos found at I.* (#1093) 
* Typo: change word compute by inserted code .  is the name of a previous function.

* Typo: add missing comma

* Typo: minor period typo

* Typo: form lower to upper case

* Typos found at I.*

Typo: add missing comma

Typo: minor period typo

Typo: form lower to upper case

Typos found at I.*
 2017-12-11 11:13:07 -08:00
Andrew Pardoe
3667b08ce3
Merge pull request #1095 from brenoguim/hotfix/public-deleted-methods 
Add public access modifier to examples
 2017-12-11 11:11:23 -08:00
Andrew Pardoe
fbc48fafb0
Merge pull request #1096 from brenoguim/hotfix/recommend-public-deleted-methods 
Recommend deleted methods to be public.
 2017-12-11 11:10:10 -08:00
Andrew Pardoe
6ac3ac940f
Merge pull request #1100 from breyed/patch-1 
T.concept: Remove comment unnecessary in good example
 2017-12-11 11:08:46 -08:00
Gabriel Dos Reis
79dd574a65 Fix #1004 2017-12-11 10:59:13 -08:00
Andrew Pardoe
4bbcd758f2 updating date 2017-12-11 10:51:03 -08:00
Edward Brey
0931fab3d5
T.concept: Remove comment unnecessary in good example 
The properly defined `Number` concept used as the template type is fully expressive.
 2017-12-05 13:46:59 -06:00
Jonathan Wakely
bdc07cc4ef Fix link to Rt-concepts 
Fixes #1099
 2017-12-05 19:25:09 +00:00
Breno Rodrigues Guimaraes
771a75e183 Add note to make deleted methods public 2017-12-02 16:46:47 -08:00
Breno Rodrigues Guimaraes
eb0707d7ae Add public access modifier to examples 2017-12-02 16:27:43 -08:00
hsutter
e6ac978f3a Updated due to discussion about #1068 2017-11-27 11:56:15 -08:00
Andrew Pardoe
2b4438603c Updating date 2017-11-27 11:52:45 -08:00
Andrew Pardoe
0a6167e1fc
Merge pull request #1066 from brenoguim/hotfix/add-virtual-destructor 
Add virtual destructor to base class "Device"
 2017-11-27 11:18:23 -08:00
Andrew Pardoe
0364ecace7
Merge pull request #1073 from martinfinke/hotfix/avoid-magic-constant 
Avoid magic constant in F.44
 2017-11-27 11:16:05 -08:00
Andrew Pardoe
b553f02f84
Merge pull request #1075 from Eliyahu-Ravuna/patch-2 
Link added for function objects and lambdas
 2017-11-27 11:15:33 -08:00
Leonardo Perez Pulido
16e270dee9 Typo: add missing question mark 2017-11-27 10:43:15 -04:00
Leonardo Perez Pulido
7f909cc18e Typo: add missing comma 2017-11-26 10:03:48 -04:00
Leonardo Perez Pulido
27d1c01782 Typo: add missing semicolon 2017-11-24 19:48:48 -04:00
Florian Behrens
3d4e860bdd Fixed comment in example code of F.54 (#1082) 2017-11-17 10:20:09 -05:00
Oleg Artenii
df68bfdc5b fixed minor typo: it this -> this (on master) (#1079) 2017-11-14 11:47:43 +00:00
Thomas Schaub
90076b9795 Use correct header level (#1078) 2017-11-13 15:59:51 -05:00
Eliyahu Ravuna
eb5f6a5b90
Link added for function objects and lambdas 2017-11-09 19:56:41 +02:00
Mohit Jain
7be6e7daed Fix typo in destructor name (#1074) 
Itream -> Istream in I.30: Encapsulate rule violations code snippet
 2017-11-09 12:53:13 -05:00
Martin Finke
d13ac81e27 Avoid magic constant 2017-11-09 05:18:11 +01:00
Jonas Toth
8a408d8500 reorder ES.expr and ES.stmt in text 2017-10-31 16:22:07 +00:00
Breno Rodrigues Guimaraes
3a320fdf53 Add virtual destructor to base class 2017-10-28 15:53:33 -07:00
brenoguim
165c79b417 Break comment to respect 100 column limit (#1069) 2017-10-28 23:24:08 +01:00
hsutter
768e4620d4 Closes #1055 2017-10-25 13:59:16 -07:00
hsutter
ab67676e7d Closes #1048 2017-10-24 15:22:28 -07:00
Andrew Pardoe
5b82257e15 Changing date 2017-10-23 11:54:20 -07:00
Andrew Pardoe
0a85bd8382 Merge pull request #1059 from luav/example-cp.4 
Example CP.4 (task vs thread)
 2017-10-23 11:25:56 -07:00
Jonathan Wakely
7a5ab334a0 Update CppCoreGuidelines.md 2017-10-23 19:24:53 +01:00
Andrew Pardoe
a1b3a269fc Merge pull request #1053 from sgkim126/master 
Fix typos in example.
 2017-10-23 11:22:21 -07:00
Andrew Pardoe
19d7fb1421 Update CppCoreGuidelines.md 2017-10-23 11:22:02 -07:00
Andrew Pardoe
17f76d0258 Update CppCoreGuidelines.md 2017-10-23 11:20:37 -07:00
Andrew Pardoe
3d282d21ed Merge pull request #1061 from planetchili/master 
struct -> class to conform to C8
 2017-10-23 11:07:33 -07:00
Andrew Pardoe
3575bf6d43 Update CppCoreGuidelines.md 2017-10-23 11:06:25 -07:00
Jay Bazuzi
a277ba71da Update forward looking statement. 2017-10-23 10:37:37 -07:00
Yogendra Singh
c4f833ad5c Simple typo fix. (#1060) 2017-10-19 11:06:55 +01:00
Jonathan Wakely
74cab35f85 Improve hyperlink text in C.8 2017-10-19 11:05:26 +01:00
chili
ace8d7b279 struct -> class to conform to C8 2017-10-19 10:28:16 +09:00
luav
17fe8a957f Manual non-async task removed 2017-10-16 12:08:21 +02:00
luav
147f4d2dc3 Spaces in blank lines removed 2017-10-15 10:42:51 +02:00
luav
f8159d26e0 Formatting and grammer fixed 2017-10-15 10:31:33 +02:00
luav
45376bb6b2 Example CP.4 (task vs thread) 2017-10-15 10:06:01 +02:00
Jonathan Wakely
e251862408 Adjust "formatting" to pass spellchecking 2017-10-07 16:15:56 +01:00
Seulgi Kim
05c44d23ab Fix typos in example. 2017-10-08 00:00:04 +09:00
Andrew Pardoe
f3596553a5 .\CppCoreGuidelines.md 2017-10-05 10:13:57 -07:00
Tom Isaacson
9cf0fcf19d #1045 Fix reference to narrow_cast (#1046) 2017-10-03 17:23:48 +01:00
Jonathan Wakely
58e80fc2c5 Adjust "incomplet and incorrekt" joke. 
This adjusts it to be closer to the form in the C++ working drafts.

Fixes #1043
 2017-10-02 23:48:22 +01:00
Jonathan Wakely
6153d69b2c Fix CI errors due to missing whitespace around operators (#1037) 
Also rephrase comments to avoid overlong lines.
 2017-10-02 19:39:18 +01:00
JonasToth
2184c57dd1 reorder sections C.167 and C.168 to be in numerical ascending order (#1034) 2017-09-28 13:23:28 +01:00
Franz Hollerer
531952a300 Issue #999 c128 applied to c129 (#1036) 2017-09-26 11:27:49 +01:00
Artem Golubikhin
d318a68e35 ES.20: Fix typo (#1033) 2017-09-18 22:50:19 +01:00
hsutter
1b2ba25b4b Closes #997 2017-09-18 12:06:35 -07:00
Andrew Pardoe
74c36a43b0 Fixing ES.87 2017-09-18 11:13:09 -07:00
Artem Golubikhin
f77fa1ad40 R.1: Fix finally link 2017-09-18 19:50:36 +03:00
Bjarne Stroustrup
6574f05356 added ES.87 about conditions in if-statements 
#1006 and #1010
 2017-09-17 18:51:43 -04:00
Bjarne Stroustrup
1a3de0e9b8 add a cross reference to P.3 2017-09-17 18:13:16 -04:00
Bjarne Stroustrup
2839c87890 add example to R.20 
addresses #1015
 2017-09-17 17:54:33 -04:00
Neil MacIntosh
b87d21b662 Merge pull request #1018 from Cleroth/patch-1 
Avoid `std::endl` :)
 2017-09-11 11:24:33 -07:00
Gabriel Dos Reis
6d5a219e66 Merge pull request #1023 from marzojr/master 
Fixing memory handling in E.5 example
 2017-09-11 11:22:06 -07:00
Gabriel Dos Reis
26f3ee9cfd Fix #998. 2017-09-11 10:48:20 -07:00
Gabriel Dos Reis
7146b55d30 Fix #1008. 2017-09-11 10:36:50 -07:00
Sebastian Valle
9840eefacf CP.2: Fixed a typo in the async example code. (#1030) 
span a task -> spawn a task
 2017-08-21 18:01:00 +01:00
tg-m
7a3d3c5a29 Fix issue #1026 (#1027) 2017-08-18 15:59:16 +01:00
Ivan Baidakou
c2456ccf5b Fix typo: Public -> public (#1025) 2017-08-13 13:22:06 +01:00
Andrew Pardoe
c04e3657fb Updating date 2017-08-11 10:41:03 -07:00
Marzo Sette Torres Junior
0bb69d80e6 Fixing memory handling in E.5 example 
Instead of constructing an array, it constructs and deletes a single double, and accesses elements as if it had constructed an array.
 2017-08-08 16:37:19 +02:00
Cleroth
d51a304e0a Update CppCoreGuidelines.md 2017-08-06 21:36:48 +02:00
TalLancaster
e61f111301 Per C.66: a global edit adding noexcept to move constructor/assignment examples (#1016) 2017-08-06 15:25:29 +01:00
Cleroth
43f378c6b3 Avoid std::endl :) 2017-08-06 11:04:41 +02:00
Gabriel Dos Reis
4ffab15e77 Merge pull request #1012 from franzhollerer/aligning_case_with_switch 
aligning case with switch
 2017-08-01 17:05:57 -07:00
Gabriel Dos Reis
e5e7082efa Merge pull request #1013 from franzhollerer/opening_brace_in_same_line_as_switch 
opening brace in same line with switch statement to be aligned with NL.17
 2017-08-01 17:05:24 -07:00