diff options
author | Paul Wilkinson <paul.wilkinson@cantab.net> | 2016-02-21 15:52:09 (GMT) |
---|---|---|
committer | Paul Wilkinson <paul.wilkinson@cantab.net> | 2016-02-21 15:52:09 (GMT) |
commit | 83d3b47acf8ab7ca010cacd9bc9f06bcabe69c38 (patch) | |
tree | 7cd07122db9c110006ffb17db02041ff84d5b699 /googletest | |
parent | 77d6b173380332b1c1bc540532641f410ec82d65 (diff) | |
download | googletest-83d3b47acf8ab7ca010cacd9bc9f06bcabe69c38.zip googletest-83d3b47acf8ab7ca010cacd9bc9f06bcabe69c38.tar.gz googletest-83d3b47acf8ab7ca010cacd9bc9f06bcabe69c38.tar.bz2 |
Fix formatting in AdvancedGuide.mdrefs/pull/719/head
Put occurrences of "#include" in a code span so they are not interpreted
as headers.
Other documents were not broken because the #include was not at the
start of the line, but put them in code spans anyway just in case the
text gets refilled in the future.
Diffstat (limited to 'googletest')
-rw-r--r-- | googletest/README.md | 2 | ||||
-rw-r--r-- | googletest/docs/AdvancedGuide.md | 6 | ||||
-rw-r--r-- | googletest/docs/FAQ.md | 2 | ||||
-rw-r--r-- | googletest/docs/V1_5_AdvancedGuide.md | 4 | ||||
-rw-r--r-- | googletest/docs/V1_6_AdvancedGuide.md | 4 | ||||
-rw-r--r-- | googletest/docs/V1_6_FAQ.md | 2 | ||||
-rw-r--r-- | googletest/docs/V1_7_AdvancedGuide.md | 4 | ||||
-rw-r--r-- | googletest/docs/V1_7_FAQ.md | 2 |
8 files changed, 13 insertions, 13 deletions
diff --git a/googletest/README.md b/googletest/README.md index e0ea1b0..edd4408 100644 --- a/googletest/README.md +++ b/googletest/README.md @@ -221,7 +221,7 @@ your build script. ### Avoiding Macro Name Clashes ### In C++, macros don't obey namespaces. Therefore two libraries that -both define a macro of the same name will clash if you #include both +both define a macro of the same name will clash if you `#include` both definitions. In case a Google Test macro clashes with another library, you can force Google Test to rename its macro to avoid the conflict. diff --git a/googletest/docs/AdvancedGuide.md b/googletest/docs/AdvancedGuide.md index 4c4ecb5..7ba8d12 100644 --- a/googletest/docs/AdvancedGuide.md +++ b/googletest/docs/AdvancedGuide.md @@ -1450,7 +1450,7 @@ two cases to consider: Both static functions and definitions/declarations in an unnamed namespace are only visible within the same translation unit. To test them, you can `#include` -the entire `.cc` file being tested in your `*_test.cc` file. (#including `.cc` +the entire `.cc` file being tested in your `*_test.cc` file. (`#include`ing `.cc` files is not a good way to reuse code - you should not do this in production code!) @@ -1551,8 +1551,8 @@ exception, you could catch the exception and assert on it. But Google Test doesn't use exceptions, so how do we test that a piece of code generates an expected failure? -`"gtest/gtest-spi.h"` contains some constructs to do this. After -#including this header, you can use +`"gtest/gtest-spi.h"` contains some constructs to do this. After +`#include`ing this header, you can use | `EXPECT_FATAL_FAILURE(`_statement, substring_`);` | |:--------------------------------------------------| diff --git a/googletest/docs/FAQ.md b/googletest/docs/FAQ.md index 639c250..5fd6cb7 100644 --- a/googletest/docs/FAQ.md +++ b/googletest/docs/FAQ.md @@ -994,7 +994,7 @@ you can use the _horrible_ hack of sniffing your executable name ## Google Test defines a macro that clashes with one defined by another library. How do I deal with that? ## In C++, macros don't obey namespaces. Therefore two libraries that -both define a macro of the same name will clash if you #include both +both define a macro of the same name will clash if you `#include` both definitions. In case a Google Test macro clashes with another library, you can force Google Test to rename its macro to avoid the conflict. diff --git a/googletest/docs/V1_5_AdvancedGuide.md b/googletest/docs/V1_5_AdvancedGuide.md index 9511f22..34e19c2 100644 --- a/googletest/docs/V1_5_AdvancedGuide.md +++ b/googletest/docs/V1_5_AdvancedGuide.md @@ -1365,7 +1365,7 @@ two cases to consider: Both static functions and definitions/declarations in an unnamed namespace are only visible within the same translation unit. To test them, you can `#include` -the entire `.cc` file being tested in your `*_test.cc` file. (#including `.cc` +the entire `.cc` file being tested in your `*_test.cc` file. (`#include`ing `.cc` files is not a good way to reuse code - you should not do this in production code!) @@ -1467,7 +1467,7 @@ Test doesn't use exceptions, so how do we test that a piece of code generates an expected failure? `<gtest/gtest-spi.h>` contains some constructs to do this. After -#including this header, you can use +`#include`ing this header, you can use | `EXPECT_FATAL_FAILURE(`_statement, substring_`);` | |:--------------------------------------------------| diff --git a/googletest/docs/V1_6_AdvancedGuide.md b/googletest/docs/V1_6_AdvancedGuide.md index 5225341..78864b1 100644 --- a/googletest/docs/V1_6_AdvancedGuide.md +++ b/googletest/docs/V1_6_AdvancedGuide.md @@ -1447,7 +1447,7 @@ two cases to consider: Both static functions and definitions/declarations in an unnamed namespace are only visible within the same translation unit. To test them, you can `#include` -the entire `.cc` file being tested in your `*_test.cc` file. (#including `.cc` +the entire `.cc` file being tested in your `*_test.cc` file. (`#include`ing `.cc` files is not a good way to reuse code - you should not do this in production code!) @@ -1549,7 +1549,7 @@ Test doesn't use exceptions, so how do we test that a piece of code generates an expected failure? `"gtest/gtest-spi.h"` contains some constructs to do this. After -#including this header, you can use +`#include`ing this header, you can use | `EXPECT_FATAL_FAILURE(`_statement, substring_`);` | |:--------------------------------------------------| diff --git a/googletest/docs/V1_6_FAQ.md b/googletest/docs/V1_6_FAQ.md index 6d5d128..2b7f784 100644 --- a/googletest/docs/V1_6_FAQ.md +++ b/googletest/docs/V1_6_FAQ.md @@ -989,7 +989,7 @@ you can use the _horrible_ hack of sniffing your executable name ## Google Test defines a macro that clashes with one defined by another library. How do I deal with that? ## In C++, macros don't obey namespaces. Therefore two libraries that -both define a macro of the same name will clash if you #include both +both define a macro of the same name will clash if you `#include` both definitions. In case a Google Test macro clashes with another library, you can force Google Test to rename its macro to avoid the conflict. diff --git a/googletest/docs/V1_7_AdvancedGuide.md b/googletest/docs/V1_7_AdvancedGuide.md index 83a8f79..dd4af8f 100644 --- a/googletest/docs/V1_7_AdvancedGuide.md +++ b/googletest/docs/V1_7_AdvancedGuide.md @@ -1448,7 +1448,7 @@ two cases to consider: Both static functions and definitions/declarations in an unnamed namespace are only visible within the same translation unit. To test them, you can `#include` -the entire `.cc` file being tested in your `*_test.cc` file. (#including `.cc` +the entire `.cc` file being tested in your `*_test.cc` file. (`#include`ing `.cc` files is not a good way to reuse code - you should not do this in production code!) @@ -1550,7 +1550,7 @@ Test doesn't use exceptions, so how do we test that a piece of code generates an expected failure? `"gtest/gtest-spi.h"` contains some constructs to do this. After -#including this header, you can use +`#include`ing this header, you can use | `EXPECT_FATAL_FAILURE(`_statement, substring_`);` | |:--------------------------------------------------| diff --git a/googletest/docs/V1_7_FAQ.md b/googletest/docs/V1_7_FAQ.md index ded1a48..3dd914d 100644 --- a/googletest/docs/V1_7_FAQ.md +++ b/googletest/docs/V1_7_FAQ.md @@ -989,7 +989,7 @@ you can use the _horrible_ hack of sniffing your executable name ## Google Test defines a macro that clashes with one defined by another library. How do I deal with that? ## In C++, macros don't obey namespaces. Therefore two libraries that -both define a macro of the same name will clash if you #include both +both define a macro of the same name will clash if you `#include` both definitions. In case a Google Test macro clashes with another library, you can force Google Test to rename its macro to avoid the conflict. |