docs: fix PathLike warning breaking the strict docs build#5310
Merged
xrmx merged 1 commit intoJun 17, 2026
Conversation
The file exporter (open-telemetry#5207) type hints use ``from os import PathLike``, which sphinx renders as the bare name ``PathLike`` and cannot resolve, failing the strict (-W) docs build. Add it to nitpick_ignore alongside the other unresolvable stdlib/third-party targets.
MikeGoldsmith
added
the
Skip Changelog
herin049
approved these changes
Jun 16, 2026
github-project-automation
Bot
moved this from Easy to review / merge / close
to Approved PRs
in Python PR digest
xrmx
approved these changes
Jun 17, 2026
Merged
via the queue into
open-telemetry:main
with commit Jun 17, 2026
4c8569d
520 of 521 checks passed
github-project-automation
Bot
moved this from Ready for merge
to Done
in Python PR digest
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The file exporter added in #5207 annotates its constructors with
path: str | PathLike[str]usingfrom os import PathLike.sphinx_autodoc_typehintsrenders this as the bare name
PathLike, which (undernitpicky = True) cannot beresolved to
os.PathLike. This makes the strict docs build (sphinx-build -W) fail:across
FileSpanExporter,FileMetricExporter, andFileLogExporter.This adds
("py:class", "PathLike")tonitpick_ignoreindocs/conf.py, consistentwith how the repo already handles other unresolvable stdlib/third-party targets
(
Token,ObjectProxy,Union, etc.).Verification
uv run tox -e docs(the same-Wbuild CI runs) now succeeds.Type of change