Merge "[FAB-3466] Error Handling"

hyperledger · May 3, 2017 · 1dfdee5 · 1dfdee5
2 parents 9c82780 + 4141f89
commit 1dfdee5
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 5 deletions.
diff --git a/docs/source/error-handling.rst b/docs/source/error-handling.rst
@@ -4,8 +4,8 @@ Error handling
 General Overview
 ----------------
 The Fabric error handling framework can be found in the Fabric repository under
-common/errors. It defines a new type of error, CallStackError, to use in place of
-the standard error type provided by Go.
+**common/errors**. It defines a new type of error, CallStackError, to use in
+place of the standard error type provided by Go.
 
 A CallStackError consists of the following:
 
@@ -26,19 +26,17 @@ components for those using an editor with code completion capabilities.
 - Reason code - a short code to help identify the reason the error occurred.
   Reason codes should consist of three numeric values. Letters and special
   characters are not allowed.
-
 - Error code - the component code and reason code separated by a colon,
   e.g. PER:404
-
 - Error message - the text that describes the error. This is the same as the
   input provided to ``fmt.Errorf()`` and ``Errors.New()``. If an error has been
   wrapped into the current error, its message will be appended.
-
 - Callstack - the callstack at the time the error is created. If an error has
   been wrapped into the current error, its error message and callstack will be
   appended to retain the context of the wrapped error.
 
 The CallStackError interface exposes the following functions:
+
 - Error() - returns the error message with callstack appended
 - Message() - returns the error message (without callstack appended)
 - GetComponentCode()

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -61,6 +61,7 @@ Before diving in, watch how Fabric is `Building a Blockchain for Business <https
    configtx
    configtxgen
    cc-packaging-and-signing
+   error-handling
    Setup/logging-control
 
 .. toctree::