[avro] branch avro-3522-better-logging-in-tests updated: AVRO-3522: Improve the README

[mg...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

mgrigorov pushed a commit to branch avro-3522-better-logging-in-tests
in repository https://gitbox.apache.org/repos/asf/avro.git


The following commit(s) were added to refs/heads/avro-3522-better-logging-in-tests by this push:
     new b2b05c38a AVRO-3522: Improve the README
b2b05c38a is described below

commit b2b05c38a5d7355620c585fb9bb0896891941a8e
Author: Martin Tzvetanov Grigorov <mg...@apache.org>
AuthorDate: Tue May 17 21:41:26 2022 +0300

    AVRO-3522: Improve the README
    
    Signed-off-by: Martin Tzvetanov Grigorov <mg...@apache.org>
---
 lang/rust/avro_test_helper/README.md | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/lang/rust/avro_test_helper/README.md b/lang/rust/avro_test_helper/README.md
index 11064757f..924516922 100644
--- a/lang/rust/avro_test_helper/README.md
+++ b/lang/rust/avro_test_helper/README.md
@@ -24,7 +24,10 @@ A module that provides several test related goodies to the other Avro crates:
 
 ### Custom Logger
 
-The logger both collects the logged messages and delegates to env_logger so that they printed on the stderr
+The logger:
+
+* collects the logged messages, so that a test could assert what has been logged
+* delegates to env_logger so that they printed on the stderr
 
 ### Colorized Backtraces
 
@@ -44,5 +47,5 @@ Since integration tests are actually crates without Cargo.toml, the test author
 
 To assert that a given message was logged, use the `assert_logged` function.
 ```rust
-assert_logged("An expected message");
+apache_avro_test_helper::logger::assert_logged("An expected message");
 ```