Repository navigation
Document WebDriverServer and drop the BiDiServer alias handling - #124
Merged
Merged
Conversation
lightpanda-python added WebDriverServer and AsyncWebDriverServer as aliases of BiDiServer and AsyncBiDiServer. pdoc documents an alias as a variable, so it gets no section, yet collect_links mapped every __all__ name to its own heading id, leaving a link to #webdriverserver with no target and failing the generator. Point an alias at the class it names.
lightpanda-python drops BiDiServer for WebDriverServer with no alias (lightpanda-io/lightpanda-python#17), so the alias handling in the reference generator has nothing left to resolve: remove it. Point the Python guide's robots.txt note at WebDriverServer and regenerate the reference against that branch.
arrufat
changed the title
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
1 participant
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.
The python-reference workflow failed with
links to missing heading ids: webdriverserver: lightpanda-python #16 addedWebDriverServer/AsyncWebDriverServeras aliases ofBiDiServer/AsyncBiDiServer, pdoc documents an alias as a variable with no section, and theBiDiServerdocstring linked to the alias.Rather than teach the generator about aliases, lightpanda-io/lightpanda-python#17 removes them:
WebDriverServerbecomes the class andBiDiServeris gone. This PR follows that:main(the alias handling first pushed here is reverted)WebDriverServerinstead ofBiDiServerreference/python.mdxis regenerated against the update missing subdomain #17 branch, which also picks up the classic WebDriver docs and other upstream changes since the last runMerge lightpanda-io/lightpanda-python#17 first: until it lands, the workflow still fails on
main.