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

Documentation and type hinting validation for utils-ts compliant utils-py functionality #117

Closed
aorumbayev opened this issue Oct 21, 2024 · 1 comment
Assignees
Labels
algokitv3 AlgoKit v3 backlog items

Comments

@aorumbayev
Copy link
Contributor

Description

The goal is to ensure clear and cohesive documentation that mirrors the structure of utils-ts docs. Additionally, validating type hinting on new AlgorandClient based abstractions, as well as ensuring deprecation notes on all legacy stateless functions that were available before.

Technical Details

Acceptance Criteria

  • algokit-utils-py documentation are up-to-date, high level structure matches docs of latest algokit-utils-ts.
  • Type hinting allows intuitive usage of the package
  • Legacy methods provide convenient and granular guides on how to update to latest recommended usage
@aorumbayev
Copy link
Contributor Author

Implemented as part of #119 and follow up beta patch PRs. Outcome itself is to be closed after prod release of utils-v3

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

No branches or pull requests

1 participant