From ea2ffbe002698b9d7ce3ab7b18591a4eadf66649 Mon Sep 17 00:00:00 2001 From: Jason Etcovitch Date: Wed, 21 Aug 2019 01:16:51 -0400 Subject: [PATCH] Some more in the docs --- docs/github-package.md | 6 +++--- docs/package-specs.md | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/github-package.md b/docs/github-package.md index 7b2f3341..8d5cac29 100644 --- a/docs/github-package.md +++ b/docs/github-package.md @@ -8,7 +8,7 @@ Its main purpose will be to provide a hydrated GitHub context/Octokit client wit ##### interfaces.ts -``` +```ts /* * Interfaces */ @@ -56,7 +56,7 @@ export interface WebhookPayloadWithRepository { Contains a GitHub context -``` +```ts export class Context { /** * Webhook payload object that triggered the workflow @@ -89,7 +89,7 @@ export class Context { Contains a hydrated Octokit client -``` +```ts export class GithubClient extends Octokit { // For making GraphQL requests public graphql: (query: string, variables?: Variables) => Promise diff --git a/docs/package-specs.md b/docs/package-specs.md index 712b699e..023c7e85 100644 --- a/docs/package-specs.md +++ b/docs/package-specs.md @@ -6,7 +6,7 @@ In order to support the node-config action, I propose adding the following into Holds all the functions necessary for interacting with the runner/environment. -``` +```ts // Logging functions export function debug(message: string): void export function warning(message: string): void @@ -66,7 +66,7 @@ export function setFailed(message: string): void Holds all the functions necessary for file system manipulation (cli scenarios, not fs replacements): -``` +```ts /** * Interface for cp/mv options */ @@ -132,7 +132,7 @@ export function which(tool: string, options?: WhichOptions): Promise Holds all the functions necessary for running the tools node-config depends on (aka 7-zip and tar) -``` +```ts /** * Interface for exec options */ @@ -155,7 +155,7 @@ export function exec(commandLine: string, args?: string[], options?: IExecOption Holds all the functions necessary for downloading and caching node. -``` +```ts /** * Download a tool from an url and stream it into a file *