Skip to content

Documentation fixes for SCAL-258631 #231

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

ShashiSubramanya
Copy link
Contributor

  • getInitConfig doc update - SCAL-258631
  • doc reference for actions - SCAL-251659
  • link text fix in customization interface description

@ShashiSubramanya ShashiSubramanya requested a review from a team as a code owner June 12, 2025 10:55
@mnk-blr
Copy link
Collaborator

mnk-blr commented Jun 12, 2025

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

security/snyk check is complete. No issues have been found. (View Details)

license/snyk check is complete. No issues have been found. (View Details)

Copy link

pkg-pr-new bot commented Jun 12, 2025

Open in StackBlitz

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

commit: be258cf

* @returns {@link EmbedConfig} The configuration embed was initialized with.
* Gets the `EmbedConfig` object that was used to
* initialize the SDK. You can use this method to access the
* embed configuration configuration settings such as the ThoughtSpot host,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo double configuration

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ack. Fixed it in the new commit.

*
* @example
* ```
* const config = getInitConfig();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see this as description for getEmbedConfig instead of getInitConfig?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The SDK docs point to this section (embedConfig.ts#L12) - https://developers.thoughtspot.com/docs/Function_getInitConfig.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants