apple / apple/swift-distributed-tracing

Sparse documentation on `Span.isRecording`

Open
#81 1 comment 0 reactions 0 assignees View on GitHub
area/documentation
Dominant language
Swift
Stars
320
Forks
57
Avg merge
4d 5h
Merged PRs (30d)
1

Description

The current documentation about Span.isRecording is:

```
/// Returns true if this `Span` is recording information like events, attributes, status, etc.
var isRecording: Bool { get }
```

Does that mean a `Span` implementation is allowed to drop all the events on the floor? Who consumes that property? Should clients read it before they try to attach massive amounts of data to the `Span`?

Contributor guide

Open the contributing guide

Research direction

Start from the documentation for Span.isRecording and determine what the property means for dropping events, who consumes it, and whether clients should check it before attaching large amounts of data. Update the documentation to answer those questions clearly and verify the revised wording in the relevant documentation output.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.