馃搫 docs(py_info): cover system_exe in all four dimensions - #128
Merged
Conversation
`system_exe` arrived with reference coverage alone, since autodoc picks the docstring up. The other three dimensions said nothing. Worse, the how-to class diagram typed `system_executable` as `str`, which is the very claim the property exists to work around. The tutorial names resolution as a concept and shows the two paths parting company inside a virtual environment. The how-to guide points at `system_exe`, and says when the raw field is still the one you want. A new explanation section covers the two states a `PythonInfo` arrives in, diagrams the walk between them, and says why the annotation cannot carry that ordering.
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.
#127 added
system_exewith reference coverage alone, sinceautomodulepicks the docstring up on its own. 馃摎 The tutorial, the how-to guide and the explanation said nothing about it, so a reader meets the property only after going looking for it in the API listing. The how-to class diagram was also wrong in a way that matters here. It typedsystem_executableasstrwhen the field isstr | None, which is the claim the new property exists to work around.The tutorial gains resolution as a named concept beside interpreter, spec, discovery and cache, then shows
executableandsystem_exereturning one path outside a virtual environment and two paths inside one. The how-to guide readssystem_exein its metadata walkthrough and says when the raw field is still what you want, which is a hand-builtPythonInfoorfrom_exe(resolve_to_host=False). A new explanation section,Resolving a virtual environment to its base, covers the two states aPythonInfoarrives in and diagrams the prefix walk between them.One paragraph needed no new prose. The deduplication note described this fallback as "the resolved real path of each candidate's
system_executable(falling back toexecutable)", so it now names the property that means just that.