Skip to content

Commit 4141f89

Browse files
committed
[FAB-3466] Error Handling
small tweak to doc add to TOC [ci-skip] Change-Id: I9e69191607405c98c069a00c970b752585379597 Signed-off-by: Nick Gaski <[email protected]>
1 parent ca3a1a2 commit 4141f89

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

docs/source/error-handling.rst

+3-5
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Error handling
44
General Overview
55
----------------
66
The Fabric error handling framework can be found in the Fabric repository under
7-
common/errors. It defines a new type of error, CallStackError, to use in place of
8-
the standard error type provided by Go.
7+
**common/errors**. It defines a new type of error, CallStackError, to use in
8+
place of the standard error type provided by Go.
99

1010
A CallStackError consists of the following:
1111

@@ -26,19 +26,17 @@ components for those using an editor with code completion capabilities.
2626
- Reason code - a short code to help identify the reason the error occurred.
2727
Reason codes should consist of three numeric values. Letters and special
2828
characters are not allowed.
29-
3029
- Error code - the component code and reason code separated by a colon,
3130
e.g. PER:404
32-
3331
- Error message - the text that describes the error. This is the same as the
3432
input provided to ``fmt.Errorf()`` and ``Errors.New()``. If an error has been
3533
wrapped into the current error, its message will be appended.
36-
3734
- Callstack - the callstack at the time the error is created. If an error has
3835
been wrapped into the current error, its error message and callstack will be
3936
appended to retain the context of the wrapped error.
4037

4138
The CallStackError interface exposes the following functions:
39+
4240
- Error() - returns the error message with callstack appended
4341
- Message() - returns the error message (without callstack appended)
4442
- GetComponentCode()

docs/source/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ Before diving in, watch how Fabric is `Building a Blockchain for Business <https
6161
configtx
6262
configtxgen
6363
cc-packaging-and-signing
64+
error-handling
6465
Setup/logging-control
6566

6667
.. toctree::

0 commit comments

Comments
 (0)