Skip to content
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

docs/Update 35-node.md #29664

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs/Update 35-node.md #29664

wants to merge 1 commit into from

Conversation

cdiwadkar16
Copy link
Contributor

@cdiwadkar16 cdiwadkar16 commented Feb 4, 2025

Under the WSConfig section the call to create a connection says await WsSql.open(conf). That is wrong.
It should be
await WsSql.sqlConnect(confg)

Description

Please briefly describe the code changes in this pull request.

Checklist

Please check the items in the checklist if applicable.

  • Is the user manual updated?
  • Are the test cases passed and automated?
  • Is there no significant decrease in test coverage?

Under the WSConfig section the call to create a connection says await WsSql.open(conf).
That is wrong.
It should be
await WsSql.sqlConnect(confg)
@menshibin
Copy link
Contributor

menshibin commented Feb 7, 2025

This is the interface description. sqlConnect is exposed in index. ts for user convenience, and it is not a method of WsSql.

@danielclow
Copy link
Contributor

The issue is that the relationship between open and sqlConnect has not been made clear in the documentation. We will keep this open until the documentation is updated accordingly.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

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