Skip to content

Commit 28f57f0

Browse files
address review: remove events API, fix get_finished_logs xref, move changelog
- Remove docs/api/_events.rst and docs/sdk/_events.rst (events API is deprecated per MikeGoldsmith, avoid exposing it in docs). - Remove _events entries from api/index.rst and sdk/index.rst toctrees. - Drop Event class nitpick_ignore entry (no longer needed). - Fix docstring cross-reference on InMemoryLogRecordExporter from :func: to :meth: since get_finished_logs is a method, and drop its nitpick_ignore entry. - Move changelog entry from 1.41.0/0.62b0 to Unreleased.
1 parent 8446ec1 commit 28f57f0

7 files changed

Lines changed: 3 additions & 27 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
3434
([#5120](https://github.com/open-telemetry/opentelemetry-python/pull/5120))
3535
- Add WeaverLiveCheck test util
3636
([#5088](https://github.com/open-telemetry/opentelemetry-python/pull/5088))
37+
- Add missing .rst files to Sphinx documentation build for SDK logs, propagators, and exporter submodules
38+
([#5017](https://github.com/open-telemetry/opentelemetry-python/pull/5017))
3739

3840
## Version 1.41.0/0.62b0 (2026-04-09)
3941

@@ -50,8 +52,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
5052
([#5034](https://github.com/open-telemetry/opentelemetry-python/pull/5034))
5153
- Fix `BatchLogRecordProcessor` default `schedule_delay_millis` from 5000ms to 1000ms to comply with the OTel specification. Note: logs may be exported 5x more frequently by default (e.g. for users who don't explicitly set the `OTEL_BLRP_SCHEDULE_DELAY` env var).
5254
([#4998](https://github.com/open-telemetry/opentelemetry-python/pull/4998))
53-
- Add missing .rst files to Sphinx documentation build for SDK logs, propagators, and exporter submodules
54-
([#5017](https://github.com/open-telemetry/opentelemetry-python/pull/5017))
5555
- `opentelemetry-sdk`: Add `process` resource detector support to declarative file configuration via `detection_development.detectors[].process`
5656
([#5001](https://github.com/open-telemetry/opentelemetry-python/pull/5001))
5757
- `opentelemetry-sdk`: Add shared `_parse_headers` helper for declarative config OTLP exporters

docs/api/_events.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/api/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ For the concrete implementation of these interfaces, see the
1414
.. toctree::
1515
:maxdepth: 1
1616

17-
_events
1817
_logs
1918
attributes
2019
baggage

docs/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -174,11 +174,6 @@
174174
"py:class",
175175
"AnyValue",
176176
),
177-
(
178-
"py:class",
179-
"Event",
180-
),
181-
("py:func", "get_finished_logs"),
182177
("py:class", "Token"),
183178
]
184179

docs/sdk/_events.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/sdk/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ processed, and exported.
1414
.. toctree::
1515
:maxdepth: 1
1616

17-
_events
1817
_logs
1918
resources
2019
trace

opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/export/in_memory_log_exporter.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ class InMemoryLogRecordExporter(LogRecordExporter):
2929
3030
This class can be used for testing purposes. It stores the exported logs
3131
in a list in memory that can be retrieved using the
32-
:func:`.get_finished_logs` method.
32+
:meth:`.get_finished_logs` method.
3333
"""
3434

3535
def __init__(self):

0 commit comments

Comments
 (0)