Skip to content

Commit c1e7769

Browse files
henrymercerCopilot
andcommitted
Reword the JSDoc for parseQueriesFromInput
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent c275b4a commit c1e7769

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

‎src/config/db-config.ts‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -490,13 +490,14 @@ export async function calculateAugmentation(
490490
}
491491

492492
/**
493-
* Parses a comma-separated list of queries, which may start with '+'. `combines` is whether it
494-
* starts with '+', and `input` holds the queries, or is `undefined` if `value` is unset or empty.
495-
* Entries aren't validated, so an empty entry becomes `{ uses: "" }`.
493+
* Parses a comma-separated list of queries, which may have a '+' prefix. Entries aren't validated,
494+
* so an empty entry becomes `{ uses: "" }`.
496495
*
497496
* @param value The list of queries.
498-
* @param repositoryProperty The repository property that `value` comes from, if any. Errors name
499-
* this property, or the `queries` input if it's unset.
497+
* @param repositoryProperty The repository property that `value` comes from, if any. Error messages
498+
* refer to this property, or to the `queries` input if no property is given.
499+
* @returns An `Augmentation` containing the parsed queries and whether `value` has a '+' prefix.
500+
* The queries are `undefined` if `value` is unset or empty.
500501
* @throws A `ConfigurationError` if `value` is a '+' with no queries after it.
501502
*/
502503
export function parseQueriesFromInput(

0 commit comments

Comments
 (0)