Documentation update #2

DenysGonchar · 2025-10-28T10:31:36Z

No description provided.

codecov · 2025-10-28T10:34:46Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.59%. Comparing base (1993422) to head (44d67a1).
⚠️ Report is 9 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main       #2   +/-   ##
=======================================
  Coverage   99.59%   99.59%           
=======================================
  Files           6        6           
  Lines         246      246           
=======================================
  Hits          245      245           
  Misses          1        1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

NelsonVides · 2025-10-28T18:57:14Z

test/demo_SUITE.erl

+
+%% opentelemetry.hrl contains #span_ctx{} record declaration
+-include_lib("opentelemetry_api/include/opentelemetry.hrl").
+%% otel_tracer.hrl defines tracing marcos (e.g. ?with_span())


Suggested change

%% otel_tracer.hrl defines tracing marcos (e.g. ?with_span())

%% otel_tracer.hrl defines tracing macros (e.g. ?with_span())

NelsonVides · 2025-10-28T19:08:13Z

README.md

+  * or call `ensure_started/0` at the `SuiteModule:init_per_suite/1`
+    interface for Common Test. Since CT doesn't run multiple suites
+    in parallel, you may also want to reset `span_collector` ETS table
+    using `reset/0` interface.


Suggested change

using `reset/0` interface.

using the `reset/0` interface.

NelsonVides · 2025-10-28T19:08:55Z

README.md

+2) If possible, wrap your test scenario in a dummy root span.
+  * Use `OpenTelemetry.Tracer.with_span/2` macro for Elixir projects
+  * or `?with_span/3` macro from `otel_tracer.hrl` for Erlang projects.
+  * Extract root span's `trace_id` and `span_id` (you can use


Suggested change

* Extract root span's `trace_id` and `span_id` (you can use

* Extract the root span's `trace_id` and `span_id` (you can use the

NelsonVides · 2025-10-28T19:09:22Z

README.md

+    `OpentelemetryTesting.get_span_ids/0` helper function for Elixir projects).
+
+3) Wait for the root span to be reported and build the span tree for it.
+  * Use `wait_for_span/3` and `build_span_tree/2` functions for this.


Suggested change

* Use `wait_for_span/3` and `build_span_tree/2` functions for this.

* Use the `wait_for_span/3` and `build_span_tree/2` functions for this.

NelsonVides · 2025-10-28T19:09:43Z

README.md

+
+3) Wait for the root span to be reported and build the span tree for it.
+  * Use `wait_for_span/3` and `build_span_tree/2` functions for this.
+  * Span tree is a recursive tuple structure with two elements:


Suggested change

* Span tree is a recursive tuple structure with two elements:

* A span tree is a recursive tuple structure with two elements:

Suggested change

* Span tree is a recursive tuple structure with two elements:

* The -pan tree is a recursive tuple structure with two elements:

NelsonVides · 2025-10-28T19:19:53Z

README.md

+  * `'_'` atom matches anything.
+  * Atoms that start with a `$` sign (e.g. `'$some_var'`) match anything,
+    the matched value is also stored and returned.
+    Note that if such special atom is used twice in the pattern,


Suggested change

Note that if such special atom is used twice in the pattern,

Note that if such a special atom is used twice in the pattern,

NelsonVides · 2025-10-28T19:22:44Z

README.md

+  * Match function (function with arity 1, `fun matcher_fn/1`),
+    should return a boolean value. But crashing or any non `true`
+    value is treated as a failed matching. If you want to check
+    for equality to some special atom or a function with arity 1,
+    you have to use a match function:


Suggested change

* Match function (function with arity 1, `fun matcher_fn/1`),

should return a boolean value. But crashing or any non `true`

value is treated as a failed matching. If you want to check

for equality to some special atom or a function with arity 1,

you have to use a match function:

* A match function (a function with arity 1, `fun matcher_fn/1`),

should return a boolean value. However, crashing or any non-true

value is treated as a failed matching. If you want to check

for equality against some special atom or a function with arity 1,

you have to use a match function:

NelsonVides · 2025-10-28T19:24:21Z

README.md

+  * Non-empty pattern list (`[_ | _]`) matches any list containing
+    elements that match patterns in the list. Patterns in the


Suggested change

* Non-empty pattern list (`[_ | _]`) matches any list containing

elements that match patterns in the list. Patterns in the

* Non-empty pattern list (`[_ | _]`) matches any list where all patterns in the pattern list have at least one matching element in the data list. Patterns in the

NelsonVides · 2025-10-28T19:24:43Z

README.md

+    against the corresponding data element. The size of the pattern
+    tuple must be equal to the size of the data tuple.
+  * For map patterns, the corresponding data map must have identical
+    keys as the pattern map, and the corresponding data values are


Suggested change

keys as the pattern map, and the corresponding data values are

keys to the pattern map, and the corresponding data values are

NelsonVides · 2025-10-28T19:24:56Z

README.md

+    keys as the pattern map, and the corresponding data values are
+    matched against pattern values. An empty map `#{}` pattern
+    matches any map.
+  * Any other pattern value is checked for equality to the data value.


Suggested change

* Any other pattern value is checked for equality to the data value.

* Any other pattern value is checked for equality with the data value.

NelsonVides

Looks good, only one comment.

NelsonVides · 2025-10-28T20:50:04Z

rebar.config

-{ex_doc,
- [{extras, ["README.md"]},
-  {main, "README.md"},
-  {source_url, "https://github.com/ErlGang/opentelemetry_testing"}]}.


Why removing these? Don't you want to generate ex_doc ready docs?

Well, it seems that using mix for this is a better idea.

Oh, right, excellent 👌🏽

DenysGonchar requested a review from NelsonVides October 28, 2025 10:53

adding test/demo_SUITE.erl

a30cb20

DenysGonchar force-pushed the documentation-update branch 5 times, most recently from df66303 to 1be700e Compare October 28, 2025 14:37

DenysGonchar added 4 commits October 28, 2025 16:28

adding test/demo_test.exs

af24064

adding 'How to' section to README.md

66630ad

adding section about pattern-matching to README.md

a09d1e2

adding TLDR section to README.md

74169af

DenysGonchar force-pushed the documentation-update branch from 1be700e to 74169af Compare October 28, 2025 15:29

making minor updates to README.md

0cb2b11

NelsonVides reviewed Oct 28, 2025

View reviewed changes

DenysGonchar added 2 commits October 28, 2025 21:02

corrections according to review comments

abcc456

removing documentation duplicates

44d67a1

NelsonVides reviewed Oct 28, 2025

View reviewed changes

NelsonVides approved these changes Oct 28, 2025

View reviewed changes

DenysGonchar marked this pull request as ready for review October 28, 2025 22:00

DenysGonchar merged commit efc7ebb into main Oct 28, 2025
5 checks passed

DenysGonchar deleted the documentation-update branch October 28, 2025 22:02

	%% otel_tracer.hrl defines tracing marcos (e.g. ?with_span())
	%% otel_tracer.hrl defines tracing macros (e.g. ?with_span())

	* Extract root span's `trace_id` and `span_id` (you can use
	* Extract the root span's `trace_id` and `span_id` (you can use the

	* Use `wait_for_span/3` and `build_span_tree/2` functions for this.
	* Use the `wait_for_span/3` and `build_span_tree/2` functions for this.

	* Span tree is a recursive tuple structure with two elements:
	* A span tree is a recursive tuple structure with two elements:

	* Span tree is a recursive tuple structure with two elements:
	* The -pan tree is a recursive tuple structure with two elements:

	Note that if such special atom is used twice in the pattern,
	Note that if such a special atom is used twice in the pattern,

		* Non-empty pattern list (`[_ \| _]`) matches any list containing
		elements that match patterns in the list. Patterns in the

	keys as the pattern map, and the corresponding data values are
	keys to the pattern map, and the corresponding data values are

	* Any other pattern value is checked for equality to the data value.
	* Any other pattern value is checked for equality with the data value.

Documentation update #2

Documentation update #2

Uh oh!

Conversation

DenysGonchar commented Oct 28, 2025

Uh oh!

codecov bot commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NelsonVides left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Oct 28, 2025 •

edited

Loading