Skip to content

Commit 3d417c7

Browse files
committed
Fix docs
1 parent 2829707 commit 3d417c7

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -325,11 +325,11 @@ Below is a checklist of things to be mindful of when implementing a new instrume
325325
### Update supported instrumentation package versions
326326

327327
- Navigate to the **instrumentation package directory:**
328-
- Update **`pyproject.toml`** file by modifying _instruments_ or _instruments-any_ entry in the `[project.optional-dependencies]` section with the new version constraint
328+
- Update **`pyproject.toml`** file by modifying `instruments` or `instruments-any` entry in the `[project.optional-dependencies]` section with the new version constraint
329329
- Update `_instruments` or `_instruments_any` variable in instrumentation **`package.py`** file with the new version constraint
330330
- At the **root of the project directory**, run `tox -e generate` to regenerate necessary files
331331

332-
Please note that _instruments-any_ is an optional field that can be used instead of or in addition to _instruments_. While _instruments_ is a list of dependencies, _all_ of which are expected by the instrumentation, _instruments-any_ is a list _any_ of which but not all are expected.
332+
Please note that `instruments-any` is an optional field that can be used instead of or in addition to `instruments`. While `instruments` is a list of dependencies, _all_ of which are expected by the instrumentation, `instruments-any` is a list _any_ of which but not all are expected.
333333

334334
<!-- See https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3610 for details on instruments-any -->
335335

scripts/otel_packaging.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ def get_instrumentation_packages(
6464
"optional-dependencies"
6565
]
6666
instruments = optional_dependencies.get("instruments", [])
67-
# _instruments-any is an optional field that can be used instead of or in addition to _instruments. While _instruments is a list of dependencies, all of which are expected by the instrumentation, _instruments-any is a list any of which but not all are expected.
67+
# instruments-any is an optional field that can be used instead of or in addition to instruments. While instruments is a list of dependencies, all of which are expected by the instrumentation, instruments-any is a list any of which but not all are expected.
6868
instruments_any = optional_dependencies.get("instruments-any", [])
6969
instrumentation = {
7070
"name": pyproject_toml["project"]["name"],

0 commit comments

Comments
 (0)