docs(firestore): fix formatting for pipelines docs#9908
Conversation
- Fixes `findNearest` example doc formatting, which was causing formatting to be lost for all subsequent APIs in the TOC in devsite. - Removes `Example:` and `<p>Example:` from before all code examples, since we use `@example` for this.
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request standardizes documentation formatting for Firestore pipelines by updating API review files, devsite markdown, and source JSDoc. A critical issue was identified in pipeline.ts where the removal of "Example:" labels resulted in malformed JSDoc tags with incorrect indentation and extra asterisks. These formatting errors need to be corrected across all affected methods to ensure proper documentation generation.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
MarkDuckworth
left a comment
MarkDuckworth
left a comment
There was a problem hiding this comment.
other than the version number comment, lgtm
* docs(firestore): fix ref doc issues for piplines * Update packages/firestore/src/lite-api/pipeline.ts Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update packages/firestore/src/lite-api/pipeline.ts Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * docs-devsite --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Adds `typescript` code formatting to the code examples in docs, where they're missing.
dlarocque
changed the title
2 participants
findNearestexample doc formatting, which was causing formatting to be lost for all subsequent APIs in the TOC in devsite.Example:and<p>Example:from before all code examples, since we use@examplefor this.