doc update for HostEvent.UpdateParameters and formatting fix

[ShashiSubramanya]

Doc updates for SCAL-256747

[mnk-blr]

✅ Snyk checks have passed. No issues have been found so far.

Status	Scanner	Critical	High	Medium	Low	Total (0)
✅	Licenses	0	0	0	0	0 issues
✅	Open Source Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

[gemini-code-assist]

Summary of Changes

Hello @ShashiSubramanya, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on improving the clarity and completeness of the documentation for specific HostEvent enums within src/types.ts. The changes provide more detailed parameter explanations and updated examples for UpdateParameters, and refine the parameter listing for SaveAnswer, ultimately enhancing the developer experience and understanding of these event triggers.

Highlights

• Enhanced Documentation for HostEvent.UpdateParameters: The JSDoc for HostEvent.UpdateParameters has been significantly updated to include detailed @param descriptions for name, description, and the new isVisibleToUser attribute. The accompanying example code has also been revised to demonstrate the usage of isVisibleToUser.
• Improved Parameter Ordering for HostEvent.SaveAnswer: The @param descriptions within the JSDoc for HostEvent.SaveAnswer have been reordered and grouped to improve clarity and readability, with vizId now listed first and optional attributes grouped separately.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request updates the JSDoc for HostEvent.UpdateParameters and reformats the documentation for HostEvent.SaveAnswer. The reformatting for SaveAnswer is a good improvement. However, the documentation update for UpdateParameters appears to contain an error, incorrectly listing a description parameter and omitting the value parameter. I've provided a specific comment with a suggested fix to correct the documentation for UpdateParameters.

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/thoughtspot/visual-embed-sdk/@thoughtspot/visual-embed-sdk@339

commit: 3aa6853

[sonar-prod-ts]

SonarQube Quality Gate

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication