Skip to content

docs: use an executable path in the try_first_with example #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gaborbernat merged 2 commits into from
Oct 17, 2026
+5 −4
Merged

docs: use an executable path in the try_first_with example #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7cc16a
docs: correct the try_first_with executable example
travisfortney Oct 17, 2026
99acdf9
docs: number the news fragment for PR 150
travisfortney Oct 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/changelog/150.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify the executable paths accepted by ``try_first_with`` in the standalone usage example.
8 changes: 4 additions & 4 deletions docs/how-to/standalone-usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
How-to guides
=============

Search specific directories first
-----------------------------------
Try specific executables first
------------------------------

If you know a likely location for the interpreter, pass it via ``try_first_with`` to check there
If you know the path to an interpreter executable, pass it via ``try_first_with`` to check it
before the normal search. This is useful when you have a custom Python install outside the
standard locations.

.. code-block:: python

from python_discovery import get_interpreter

info = get_interpreter("python3.12", try_first_with=["/opt/python/bin"])
info = get_interpreter("python3.12", try_first_with=["/opt/python/bin/python3.12"])
if info is not None:
print(info.executable)

Expand Down