@@ -102,11 +102,17 @@ const BOT_COMMENT_MARKER = '<!-- eslint-rule-benchmark-report -->'
102102 * comment. Uses GraphQL pagination to handle pull requests with many comments.
103103 *
104104 * @example
105- * ;```typescript
106- * const gql = createGraphQLClient();
107- * const context = { pullRequestNumber: 123, owner: 'owner', repository: 'repo', pullRequestNodeId: '' };
108- * const { botCommentInfo, pullRequestNodeId } = await findBotComment(gql, context);
109- * ```
105+ * const gql = createGraphQLClient()
106+ * const context = {
107+ * pullRequestNumber: 123,
108+ * owner: 'owner',
109+ * repository: 'repo',
110+ * pullRequestNodeId: '',
111+ * }
112+ * const { botCommentInfo, pullRequestNodeId } = await findBotComment(
113+ * gql,
114+ * context,
115+ * )
110116 *
111117 * @param {GraphQLClient } gql - Configured GraphQL client instance for GitHub
112118 * API calls
@@ -206,12 +212,10 @@ let findBotComment = async (
206212 * GitHub event payload file and parses repository information.
207213 *
208214 * @example
209- * ```typescript
210- * const context = await getPullRequestContext();
215+ * const context = await getPullRequestContext()
211216 * if (context) {
212- * console.log(`Processing PR #${context.pullRequestNumber}`);
217+ * console.log(`Processing PR #${context.pullRequestNumber}`)
213218 * }
214- * ```
215219 *
216220 * @returns {Promise<PullRequestContext | null> } Promise resolving to pull
217221 * request context or null if extraction fails
@@ -253,10 +257,8 @@ let getPullRequestContext = async (): Promise<PullRequestContext | null> => {
253257 * Creates a new comment on a GitHub pull request using GraphQL mutation.
254258 *
255259 * @example
256- * ;```typescript
257- * const gql = createGraphQLClient();
258- * await createBotComment(gql, 'PR_123456', '# Benchmark Results\n...');
259- * ```
260+ * const gql = createGraphQLClient()
261+ * await createBotComment(gql, 'PR_123456', '# Benchmark Results\n...')
260262 *
261263 * @param {GraphQLClient } gql - Configured GraphQL client instance for GitHub
262264 * API calls
@@ -295,10 +297,12 @@ let createBotComment = async (
295297 * Updates the content of an existing comment using GraphQL mutation.
296298 *
297299 * @example
298- * ;```typescript
299- * const gql = createGraphQLClient();
300- * await updateBotComment(gql, 'IC_123456', '# Updated Benchmark Results\n...');
301- * ```
300+ * const gql = createGraphQLClient()
301+ * await updateBotComment(
302+ * gql,
303+ * 'IC_123456',
304+ * '# Updated Benchmark Results\n...',
305+ * )
302306 *
303307 * @param {GraphQLClient } gql - Configured GraphQL client instance for GitHub
304308 * API calls
@@ -335,10 +339,8 @@ let updateBotComment = async (
335339 * GITHUB_TOKEN environment variable for authentication.
336340 *
337341 * @example
338- * ;```typescript
339- * const gql = createGraphQLClient();
340- * const result = await gql('query { viewer { login } }');
341- * ```
342+ * const gql = createGraphQLClient()
343+ * const result = await gql('query { viewer { login } }')
342344 *
343345 * @returns {GraphQLClient } Configured GraphQL client function ready for GitHub
344346 * API calls
@@ -365,21 +367,17 @@ let createGraphQLClient = (): GraphQLClient => {
365367 * - Includes error handling for all GitHub API operations
366368 *
367369 * @example
368- * ```typescript
369370 * const report = `
370371 * # Benchmark Results
371372 * | Rule | Time (ms) | Change |
372373 * |------|-----------|--------|
373374 * | rule1 | 150 | +5% |
374- * `;
375- * await publishGithubComment(report);
376- * ```
375+ * `
376+ * await publishGithubComment(report)
377377 *
378378 * @example
379- * ;```typescript
380379 * // Simple usage with plain text
381- * await publishGithubComment('All benchmarks passed! ✅');
382- * ```
380+ * await publishGithubComment('All benchmarks passed! ✅')
383381 *
384382 * @param {string } markdownReport - The benchmark report formatted as markdown
385383 * string
0 commit comments