Skip to content

Commit 18f7b7b

Browse files
fix: add changelog entry and nitpick_ignore for get_finished_logs
Add CHANGELOG entry for the docs PR and suppress the Sphinx cross-reference warning for get_finished_logs (referenced as :func: in a docstring we did not modify).
1 parent b703498 commit 18f7b7b

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1818
([#5034](https://github.com/open-telemetry/opentelemetry-python/pull/5034))
1919
- 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).
2020
([#4998](https://github.com/open-telemetry/opentelemetry-python/pull/4998))
21+
- Add missing .rst files to Sphinx documentation build for SDK logs, propagators, and exporter submodules
22+
([#5017](https://github.com/open-telemetry/opentelemetry-python/pull/5017))
2123
- `opentelemetry-sdk`: Add `process` resource detector support to declarative file configuration via `detection_development.detectors[].process`
2224
([#5001](https://github.com/open-telemetry/opentelemetry-python/pull/5001))
2325
- `opentelemetry-sdk`: Add shared `_parse_headers` helper for declarative config OTLP exporters

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,7 @@
178178
"py:class",
179179
"Event",
180180
),
181+
("py:func", "get_finished_logs"),
181182
]
182183

183184
# Add any paths that contain templates here, relative to this directory.

0 commit comments

Comments
 (0)