Repository navigation
docs: improve tools reference readability #21550
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| /** | ||
| * @license | ||
| * Copyright 2025 Google LLC | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| import { readFile } from 'node:fs/promises'; | ||
| import { resolve } from 'node:path'; | ||
| import { describe, expect, it } from 'vitest'; | ||
|
|
||
| const toolsReferencePath = resolve( | ||
| import.meta.dirname, | ||
| '../../docs/reference/tools.md', | ||
| ); | ||
|
|
||
| async function getAvailableToolsSection(): Promise<string> { | ||
| const toolsReference = await readFile(toolsReferencePath, 'utf8'); | ||
| const [, afterHeading = ''] = toolsReference.split('## Available tools'); | ||
| const [section = ''] = afterHeading.split('## Under the hood'); | ||
| return section; | ||
| } | ||
|
|
||
| describe('tools reference docs', () => { | ||
| it('keeps table descriptions free of embedded parameter lists', async () => { | ||
| await expect(getAvailableToolsSection()).resolves.not.toContain( | ||
| '**Parameters:**', | ||
| ); | ||
| }); | ||
| }); | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The current implementation of
getAvailableToolsSectionis not robust. If the## Available toolsheading is missing or renamed, the test will silently pass because the destructuring assignment with a default value (= '') will hide the error. This can lead to a false sense of security. To make the test more reliable, it should explicitly check that the document sections are found and throw an error if they are not. This ensures the test fails loudly if the document structure changes unexpectedly.