ifeat(trace): improve misleading comments

Author: IvanAnishchuk

tests/infra/trace/README.md

@@ -15,6 +15,9 @@ SSZ artifacts (hash-addressed to avoid duplication).
 
 ## Usage and example test
 
+You can find this example in `tests/infra/trace/test_example_slots_2.py`:
+
+
 ```python
 from tests.infra.trace.decorator import spec_trace
 
@@ -29,11 +32,10 @@ def test_linear_sanity_slots_222(
     spec.process_slot(state)
 ```
 
-This can, for example, be put into e.g.
-`tests/core/pyspec/eth2spec/test/gloas/sanity/test_slots_2.py` and then can be
-run with something like
+Example of using example test with reftests:
 
 ```bash
+cp -v tests/infra/trace/test_example_slots_2.py tests/core/pyspec/eth2spec/test/gloas/sanity/test_slots_2.py
 make reftests fork=gloas runner=sanity k=linear_sanity_slots_222 verbose=true
 ```
 
@@ -93,8 +95,8 @@ results. A decorator is used to set things up. Some simple pydantic models are
 used for the trace file structure and some sanitation/formatting.
 
 From a consumer standpoint (i.e. test runner) new tests using this decorator
-behave differently and are being detected by a new data type yielded (a
-pydantic model instance). Some logic was added to `execute_test` in
+behave differently and are being detected by a new data type yielded (a pydantic
+model instance). Some logic was added to `execute_test` in
 `tests/core/pyspec/eth2spec/gen_helpers/gen_base/gen_runner.py` to catch that
 new case and apply new serialization method.
 
@@ -118,6 +120,9 @@ Some cleanup and polishing is still required.
 
 Typing could be improved.
 
+More example tests showcasing new features (or potentially some actually
+needed tests that were waiting for this) could be added.
+
 ## Credits
 
 Thanks to Leo for the initial idea and guidance, and to all the reviewers who

tests/infra/trace/models.py

@@ -20,7 +20,6 @@ def simple_sanitize_data(value: SERIALIZED_ARGS) -> SERIALIZED_ARGS:
         return f"0x{value.hex()}"
     # recursively clean lists
     if isinstance(value, list):
-        # typing hint: nesting never added
         return [simple_sanitize_data(x) for x in value]
     return value
 
@@ -101,6 +100,7 @@ class TraceConfig(BaseModel):
     The root schema for the trace file.
     Contains metadata, context, and the execution trace.
     """
+
     model_config = ConfigDict(extra="forbid")
 
     default_fork: str = Field(default="")

tests/infra/trace/test_traced_spec.py

@@ -330,6 +330,7 @@ def test_empty_trace(recording_spec):
     proxy = recording_spec
 
     # try to save a state that's not a state
+    # this is intentionally testing internal behavior
     proxy._capture_pre_state(None)
     proxy._capture_post_state(None)
     # try to finalize without a single state being captured