Skip to content

Commit fd07e88

Browse files
author
Ivan Baidakou
committed
Improve documentation
1 parent ef2adb1 commit fd07e88

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Results achieved with `examples/speed_test_async_multi.cpp` for 1 thread, Intel
4040

4141
| bredis (commands/s) | redox (commands/s) |
4242
|----------------------------|------------------------------|
43-
| 1.30257e+06 | 1.19214e+06 |
43+
| 1.30257e+06 | 1.19214e+06 |
4444

4545
Results are not completely fair, because of usage of different semantics in
4646
APIs; however they are still interesting, as there are used different
@@ -435,16 +435,16 @@ Represents results of parse attempt. It is `boost::variant` of the following typ
435435
`no_enogh_data_t` is empty struct, meaning that buffer just does not contains enough
436436
information to completely parse it.
437437

438-
`protocol_error_t` has `std::string what` member, descriping the error in protocol,
439-
(e.g. when type in stream is specified as integer, but it cannot be converted to integer).
440-
This error should never occur in production code, meaning that no (logical) errors
441-
are expected in redis-server nor in bredis parser. The error might occur if buffer
442-
is corrupted.
438+
`protocol_error_t` has `boost::system::error_code code` member, descriping the error
439+
in protocol, (e.g. when type in stream is specified as integer, but it cannot be
440+
converted to integer). This error should never occur in production code, meaning
441+
that no (logical) errors are expected in redis-server nor in bredis parser. The
442+
error might occur if buffer is corrupted.
443443

444444
`Policy` (namespace `bredis::parsing_policy`) specifies what to do with with result:
445-
either drop it (`bredis::parsing_policy::drop_result`) or keep it
446-
(`bredis::parsing_policy::keep_result`). The helper
447-
`parse_result_mapper_t<Iterator, Policy>` helps to get proper
445+
either drop it (`bredis::parsing_policy::drop_result`) or keep it
446+
(`bredis::parsing_policy::keep_result`). The helper
447+
`parse_result_mapper_t<Iterator, Policy>` helps to get proper
448448
`positive_parse_result_t<Iterator, Policy>` type.
449449

450450
`positive_parse_result_t<Iterator, Policy>` contains members:

0 commit comments

Comments
 (0)