refactor(dev-infra): cleanup comments in git utilities (#38656)

Cleans up outdated comments in the shared dev-infra Git
utilities. We also export the Graphql client for consistency
as we expose the `GithubClient` and `GitClient` too.

PR Close #38656
This commit is contained in:
Paul Gschwendtner
2020-09-09 14:44:14 +02:00
committed by Alex Rickabaugh
parent 3e9986871c
commit b29c32b758
2 changed files with 12 additions and 15 deletions

View File

@ -69,18 +69,13 @@ export class GithubClient extends Octokit {
}
/**
* An object representation of a GraphQL Query to be used as a response type and to generate
* a GraphQL query string.
* An object representation of a GraphQL Query to be used as a response type and
* to generate a GraphQL query string.
*/
type GraphQLQueryObject = Parameters<typeof query>[1];
export type GraphQLQueryObject = Parameters<typeof query>[1];
/**
* A client for interacting with Github's GraphQL API.
*
* This class is intentionally not exported as it should always be access/used via a
* _GithubClient instance.
*/
class GithubGraphqlClient {
/** A client for interacting with Github's GraphQL API. */
export class GithubGraphqlClient {
/** The Github GraphQL (v4) API. */
private graqhql = graphql;