docs: add pylance setup and usage guide for SDK developers #718
Conversation
Signed-off-by: Raja Rathour <imraja729@gmail.com>
Signed-off-by: Raja Rathour <193507075+Raja-89@users.noreply.github.com>
There was a problem hiding this comment.
@Raja-89 please check your difference between your submission and our main, each time, before requesting a review!
You can see you've deleted a changelog entry
https://github.com/hiero-ledger/hiero-sdk-python/pull/718/files#r2484971770
Signed-off-by: Raja Rathour <imraja729@gmail.com>
Signed-off-by: Raja Rathour <imraja729@gmail.com>
|
@exploreriii , resolved |
docs/sdk_developers/pylance.md
Outdated
|
|
||
|
|
||
| ```python | ||
| from hiero_sdk.account import AccountId |
There was a problem hiding this comment.
Hi @Raja-89 very good!
However, this is wrong
correct:
from /src
from hiero_sdk_python.account.account_id import AccountId
from /examples
from hiero_sdk_python import AccountId
There was a problem hiding this comment.
Please Review it once.
Signed-off-by: Raja Rathour <imraja729@gmail.com>
Hey @exploreriii , let me know... |
|
@Raja-89 you are claiming the top one is incorrect, but its actually correct So you don't have an 'incorrect' example |
Signed-off-by: Raja Rathour <imraja729@gmail.com>
|
Hey @exploreriii I’ve also synced my branch with the latest upstream changes everything should now be up to date. Please review it once and let me know if any further refinements are needed. |
|
|
||
| - **Flagging incorrect imports** | ||
|
|
||
| - e.g., importing `hedera.account_id` instead of `hiero_sdk.account_id` |
There was a problem hiding this comment.
this does not exist
hiero_sdk.account_id
should be
from hiero_sdk_python.account.account_id
or
from hiero_sdk_python import AccountId
| If you mix up these contexts, Pylance will display an error such as: | ||
|
|
||
| ``` | ||
| Import "hiero_sdk.account.account_id" could not be resolved |
|
|
||
| --- | ||
|
|
||
| ## Fixing Invalid Imports and Calls |
There was a problem hiding this comment.
you are adding two correct examples, but your section is about invalid imports
why not give an invalid example?
that would be:
from hiero_sdk.account.account_id import AccountId
2 participants
Summary
This PR adds a new developer documentation file at
docs/sdk_developers/pylance.md.The document introduces Pylance, a powerful VS Code language server for Python, and guides contributors on how to set it up and interpret its diagnostics to improve code quality before submitting pull requests.
Details
Added
✅ Checklist
docs/sdk_developers/git commit -S -s -m "...")🔗 References
Closes: #713