From 536cb4f90c1c840ce9a7bd4932b93c3fc12511ce Mon Sep 17 00:00:00 2001 From: joemicky Date: Tue, 16 Sep 2025 15:43:36 +0800 Subject: [PATCH] chore: fix some comments Signed-off-by: joemicky --- trace-dispatcher/doc/config.yaml | 2 +- trace-dispatcher/doc/trace-dispatcher.md | 2 +- trace-dispatcher/src/Cardano/Logging/DocuGenerator.hs | 4 ++-- trace-dispatcher/test/Cardano/Logging/Test/Unit/DataPoint.hs | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/trace-dispatcher/doc/config.yaml b/trace-dispatcher/doc/config.yaml index a9bd6871965..55a6819d875 100644 --- a/trace-dispatcher/doc/config.yaml +++ b/trace-dispatcher/doc/config.yaml @@ -9,7 +9,7 @@ TraceOptions: - EKGBackend - Forwarder -# More interesing tracers +# More interesting tracers ChainDB: severity: Info diff --git a/trace-dispatcher/doc/trace-dispatcher.md b/trace-dispatcher/doc/trace-dispatcher.md index 27d4d426e9e..5c54db0606c 100644 --- a/trace-dispatcher/doc/trace-dispatcher.md +++ b/trace-dispatcher/doc/trace-dispatcher.md @@ -677,7 +677,7 @@ checkNodeTraceConfiguration :: -> IO [Text] ``` -An example text is "Config namespace error: i.am.an.invalid.namepace" . +An example text is "Config namespace error: i.am.an.invalid.namespace" . This check is performed within a `cardano-node` test case (`Test.Cardano.Tracing.NewTracing.Consistency.tests`), ensuring that it is automatically verified with each pull request. diff --git a/trace-dispatcher/src/Cardano/Logging/DocuGenerator.hs b/trace-dispatcher/src/Cardano/Logging/DocuGenerator.hs index 0cf3a0cef24..c337b74d38c 100644 --- a/trace-dispatcher/src/Cardano/Logging/DocuGenerator.hs +++ b/trace-dispatcher/src/Cardano/Logging/DocuGenerator.hs @@ -91,7 +91,7 @@ documentTracer' hook tracer = do tr' <- hook tracer documentTracer tr' --- This fuction calls document tracers and returns a DocTracer result +-- This function calls document tracers and returns a DocTracer result documentTracer :: forall a. MetaTrace a => Trace IO a @@ -286,7 +286,7 @@ documentTracer tracer = do --- | Calls the tracers in a documetation control mode, +-- | Calls the tracers in a documentation control mode, -- and returns a DocCollector, from which the documentation gets generated documentTracersRun :: forall a. MetaTrace a => [Trace IO a] -> IO DocCollector documentTracersRun tracers = do diff --git a/trace-dispatcher/test/Cardano/Logging/Test/Unit/DataPoint.hs b/trace-dispatcher/test/Cardano/Logging/Test/Unit/DataPoint.hs index 09938adce77..1663ee367d5 100644 --- a/trace-dispatcher/test/Cardano/Logging/Test/Unit/DataPoint.hs +++ b/trace-dispatcher/test/Cardano/Logging/Test/Unit/DataPoint.hs @@ -37,8 +37,8 @@ instance MetaTrace BaseStats where privacyFor (Namespace _ ["BaseStats"]) _ = Just Public documentFor (Namespace _ ["BaseStats"]) = Just "Basic statistics" metricsDocFor (Namespace _ ["BaseStats"]) = - [ ("measure", "This is the value of a single measurment") - , ("sum", "This is the sum of all measurments")] + [ ("measure", "This is the value of a single measurement") + , ("sum", "This is the sum of all measurements")] allNamespaces = [Namespace [] ["BaseStats"]] instance A.ToJSON BaseStats where