update for better comments

build/releasing/customRenderers.ts

@@ -10,6 +10,7 @@ if (!githubPAT && (process.argv.includes("bump") || process.argv.includes("publi
     );
 }
 
+// Octokit is used to access the GitHub REST API
 const github = new Octokit({
     ...repoDetails,
     ...(githubPAT && { auth: "token " + githubPAT }),

build/releasing/github/pull-requests.ts

@@ -4,9 +4,9 @@ import { IPullRequest, IRepoDetails } from "./types";
 export interface IGetPullRequestFromCommitParams {
     github: Octokit;
     repoDetails: IRepoDetails;
-    /** Commit hash */
+    // Commit hash
     commit: string;
-    /** Provide this to have it included in the resulting IPullRequest */
+    // Provide this to have it included in the resulting IPullRequest
     authorEmail?: string;
     verbose?: boolean;
 }