Fixed typos and format issues on clr-code-guide doc(dotnet/coreclr#7767) (dotnet...
authorJim Ma <mazong1123@gmail.com>
Sat, 22 Oct 2016 11:13:17 +0000 (19:13 +0800)
committerJan Kotas <jkotas@microsoft.com>
Sat, 22 Oct 2016 11:13:17 +0000 (04:13 -0700)
There're several typos and format issues. Just fixed them.

Fix issue dotnet/coreclr#7767

Commit migrated from https://github.com/dotnet/coreclr/commit/73b4f008866b153a4d86785b648de4a281981c9e

docs/coreclr/coding-guidelines/clr-code-guide.md

index 84ba5f2..c1f69b0 100644 (file)
@@ -27,7 +27,7 @@ Written in 2006, by:
     * [2.1.10 How to know if a function can trigger a GC](#2.1.10)
       * [2.1.10.1 GC_NOTRIGGER/TRIGGERSGC on a scope](#2.1.10.1)
   * [2.2 Are you using holders to track your resources?](#2.2)
-    * [2.2.1 What are holders and we are they important?](#2.2.1)
+    * [2.2.1 What are holders and why are they important?](#2.2.1)
     * [2.2.2 An example of holder usage:](#2.2.2)
     * [2.2.3 Common Features of Holders](#2.2.3)
     * [2.2.4 Where do I find a holder?](#2.2.4)
@@ -462,7 +462,7 @@ One difference between the standalone TRIGGERSGC and the contract GC_TRIGGERS: t
 
 ## <a name="2.2"/>2.2 Are you using holders to track your resources?
 
-### <a name="2.2.1"/>2.2.1 What are holders and we are they important?
+### <a name="2.2.1"/>2.2.1 What are holders and why are they important?
 
 The CLR team has coined the name **holder** to refer to the infrastructure that encapsulates the common grunt work of writing robust **backout code**. **Backout code** is code that deallocate resources or restore CLR data structure consistency when we abort an operation due to an error or an asynchronous event. Oftentimes, the same backout code will execute in non-error paths for resources allocated for use of a single scope, but error-time backout is still needed even for longer lived resources.
 
@@ -616,6 +616,7 @@ Holders consistently release on destruction – that's their whole purpose. Sadl
 #### <a name="2.2.8.4"/>2.2.8.4 Critical Section Holder
 
 **Wrong:**
+
        pCrst->Enter();
        pCrst->Leave();