Skip to content

Commit aadda80

Browse files
authored
docs: update getSatisfying JSDoc (#4745)
* docs: update getSatisfying JSDoc * chore: versions
1 parent 66957e8 commit aadda80

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

.yarn/versions/11cf053f.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
declined:
2+
- "@yarnpkg/core"

packages/yarnpkg-core/sources/Resolver.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,8 @@ export interface Resolver {
123123
getCandidates(descriptor: Descriptor, dependencies: Record<string, Package>, opts: ResolveOptions): Promise<Array<Locator>>;
124124

125125
/**
126-
* This function will, given a descriptor and a list of locator references,
127-
* find out which of the references potentially satisfy the descriptor.
126+
* This function will, given a descriptor and a list of locators,
127+
* find out which of the locators potentially satisfy the descriptor.
128128
*
129129
* This function is different from `getCandidates`, as `getCandidates` will
130130
* resolve the descriptor into a list of locators (potentially using the network),
@@ -143,7 +143,7 @@ export interface Resolver {
143143
*
144144
* @param descriptor The target descriptor.
145145
* @param dependencies The resolution dependencies and their resolutions.
146-
* @param references The candidate references.
146+
* @param locators The candidate locators.
147147
* @param opts The resolution options.
148148
*/
149149
getSatisfying(descriptor: Descriptor, dependencies: Record<string, Package>, locators: Array<Locator>, opts: ResolveOptions): Promise<{

0 commit comments

Comments
 (0)