librarian: review gemini feedback about broken docs test #2680
Description
This issue is to follow up on a finding from Gemini which appeared when deleting a manually created docs file cli-commands.md. Gemini reported that the existing docs test appeared to be broken. #2669 did not have any failing presubmits, and did not touch the docs test, which is why I'm tracking this as a separate issue.
Removing this manually-maintained documentation is a good step towards automation. However, the test that verifies the auto-generated documentation appears to be broken.
The test TestGoGenerate in cmd/librarian/doc_generate_test.go checks for changes in internal/librarian/doc.go. But the doc generator (cmd/librarian/doc_generate.go) creates the file cmd/librarian/doc.go.
Because the test is checking the wrong file, it might not be catching cases where the generated documentation is stale. This could lead to a situation where neither the old manual documentation nor the new auto-generated documentation is correct or up-to-date.
I recommend fixing the test to point to the correct file (cmd/librarian/doc.go) before removing this manual documentation file. This will ensure the new system is robust.
Metadata
Metadata
Assignees
Labels
No labels