Skip to content

Commit 2829707

Browse files
committed
correct pkg fields vs toml fields
1 parent 5bdf8ef commit 2829707

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ Below is a checklist of things to be mindful of when implementing a new instrume
326326

327327
- Navigate to the **instrumentation package directory:**
328328
- Update **`pyproject.toml`** file by modifying _instruments_ or _instruments-any_ entry in the `[project.optional-dependencies]` section with the new version constraint
329-
- Update `_instruments` or `_instruments-any` variable in instrumentation **`package.py`** file with the new version constraint
329+
- 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

332332
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.

scripts/generate_instrumentation_bootstrap.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ def main():
9393
values=[ast.Str(target_pkg), ast.Str(pkg["requirement"])],
9494
)
9595
)
96-
# _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.
96+
# 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.
9797
for target_pkg in pkg["instruments-any"]:
9898
libraries.elts.append(
9999
ast.Dict(

scripts/generate_instrumentation_readme.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ def main(base_instrumentation_path):
5959
exec(fh.read(), pkg_info)
6060

6161
instruments_and = pkg_info.get("_instruments", ())
62-
# _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.
63-
instruments_any = pkg_info.get("_instruments-any", ())
62+
# _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.
63+
instruments_any = pkg_info.get("_instruments_any", ())
6464
supports_metrics = pkg_info.get("_supports_metrics")
6565
semconv_status = pkg_info.get("_semconv_status")
6666
instruments_all = ()

0 commit comments

Comments
 (0)