open-telemetry / open-telemetry/opentelemetry-python-contrib
Error in `BaggageSpanProcessor` readme
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 1.1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 16
Description
I think this is wrong - this predicate just checks whether the key begins with the literal string ^key.+, it doesn't perform any regex matching.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open processor/opentelemetry-processor-baggage/README.rst at line 65 and review the predicate description against its stated behavior. Correct the README so it does not imply regex matching when the key is checked against the literal string ^key.+; the issue is done when the documentation accurately describes the predicate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100