You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Added comprehensive documentation for key modules:
Documentation for Address functionality (addresses.rst)
Documentation for SegWit functionality (segwit.rst)
Enhanced documentation for the Proxy module (proxy.rst)
Updated index.rst to include the new documentation files
Added Jupyter notebooks for interactive documentation:
keys_and_addresses.ipynb
proxy.ipynb
This PR is a significant step toward improving code quality, developer experience, and documentation as outlined in our TODO list. Would love to hear your feedback @karask
@karask
As everything is related to documentation improvement and creation of Jupyter notebooks
I have included them in the same PR
No functional changes have been made( except the test_proxy.py file {which also has been handled properly})
Let me know if you are okay with this approach or need any other changes
I would be happy to make it
If you want I can split it into Multiple PRs
Let me know how you want me to split it into as in what part you want in a particular PR
I was thinking of splitting it into 4 PRs
Documentation improvements (addresses.rst, segwit.rst, updated proxy.rst, index.rst updates)
Type checking improvements (mypy.ini updates, type annotations in proxy.py)
Proxy implementation enhancements (NodeProxy class revamp)
Jupyter notebooks
let me know if you find this PR suitable or you want me to go ahead with this approach or anything which you might suggest
Once again Thank you for your guidance
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR addresses several TODO items related to type checking, proxy implementation, and documentation:
Type Checking Improvements
cast()to ensure type safety while maintaining code clarityProxy Implementation Enhancements
Documentation Improvements
This PR is a significant step toward improving code quality, developer experience, and documentation as outlined in our TODO list. Would love to hear your feedback @karask
All tests pass
