From 0be6733f3058f04c72cef54242f390a5347c6841 Mon Sep 17 00:00:00 2001 From: Cameron DeCoster Date: Wed, 24 Jun 2026 14:10:27 -0600 Subject: [PATCH 1/2] fix: Update get_browser_path docstring --- src/choreographer/utils/_which.py | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/src/choreographer/utils/_which.py b/src/choreographer/utils/_which.py index ce64c1d7..f8507a44 100644 --- a/src/choreographer/utils/_which.py +++ b/src/choreographer/utils/_which.py @@ -79,13 +79,20 @@ def get_browser_path(*args: Any, **kwargs: Any) -> str | None: # noqa: D417, do """ Call `browser_which()` but check for user override first. - It looks for the browser in path. + Returns the path set by the ``BROWSER_PATH`` environment variable if set, + otherwise searches ``PATH`` via `browser_which()`. - Accepts the same arguments as `browser_which': + Accepts the same arguments as `browser_which()`: Args: executable_names: the list of names to look for - skip_local: (default False) don't look for a choreo download of anything. + ms_prog_id: A windows registry ID string to lookup program paths + + Note: + This function does not handle the choreographer-managed local browser + download. To include (or skip) a locally downloaded browser in the + search, use `choreographer.browsers.chromium.Chromium.find_browser`, + which accepts a ``skip_local`` argument. """ return os.environ.get("BROWSER_PATH", browser_which(*args, **kwargs)) From 647dd2d993e2662b0a2ff8902600813aae3fd554 Mon Sep 17 00:00:00 2001 From: Cameron DeCoster Date: Wed, 24 Jun 2026 14:13:17 -0600 Subject: [PATCH 2/2] Update changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7c9de930..69004a77 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,6 +16,7 @@ where X.Y.Z is the semver of the most recent choreographer release. ### Fixed - Improve platform architecture detection for arm on Linux and Windows [[#290](https://github.com/plotly/choreographer/pull/290)], with thanks to @juliabeliaeva for the contribution! - Fix license file and add a valid SPDX identifier to project settings [[#294](https://github.com/plotly/choreographer/pull/294)], with thanks to @ecederstrand for the contribution! +- Fix out-of-date docstring on `get_browser_path` [[#300](https://github.com/plotly/choreographer/issues/300)] ## [1.3.0] -- 2026-04-28