Ensure SDK python usability with LSP pylance / pyright

[remyleone]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

It would be helpful to ensure that our SDK are behaving properly when used with recent LSP tools that our customers will also probably use.

• It would be helpful to ensure that examples are present in the coding tips provided
• It would be helpful to ensure that documentation is well rendered in recent IDE (Jetbrains, vscode, zed)

Proposed Solution

• Ensure that all docstring are rendering properly
• Ensure that examples can be accessed easily