Skip to content

Commit f1feb66

Browse files
Clarify what a missing query field means.
1 parent e5a3133 commit f1feb66

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/client/pythonEnvironments/base/locator.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,9 @@ export const NOOP_ITERATOR: IPythonEnvsIterator = iterEmpty<PythonEnvInfo>();
7474
* This is directly correlated with the `BasicPythonEnvsChangedEvent`
7575
* emitted by watchers.
7676
*
77-
* @prop kinds - if provided, results should be limited to these env kinds
77+
* @prop kinds - if provided, results should be limited to these env
78+
* kinds; if not provided, the kind of each evnironment
79+
* is not considered when filtering
7880
*/
7981
export type BasicPythonLocatorQuery = {
8082
kinds?: PythonEnvKind[];
@@ -88,7 +90,8 @@ export type BasicPythonLocatorQuery = {
8890
*
8991
* @prop - searchLocations - if provided, results should be limited to
9092
* within these locations; `null` means "include envs that have
91-
* no search location"
93+
* no search location"; if not provided, the search location
94+
* of each enviroment is not considered when filtering
9295
*/
9396
export type PythonLocatorQuery = BasicPythonLocatorQuery & {
9497
searchLocations?: (Uri | null)[] | null;

0 commit comments

Comments
 (0)