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

Add Type Hints to Bech32 Functions #191

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

Commits on Oct 3, 2024

  1. Add Type Hints to Bech32 Functions

    This pull request adds type hints to various Bech32 encoding/decoding functions in the provided codebase. These changes aim to improve code readability and make it easier for developers to understand the parameter types and return types of each function.
    
    Adding type hints ensures that potential type errors can be caught early by tools such as `mypy`, and it also makes the code easier to maintain and review for developers in the future.
    
    Type hints have been added to the following functions:
    - `bech32_polymod`
    - `bech32_hrp_expand`
    - `bech32_verify_checksum`
    - `bech32_create_checksum`
    - `bech32_encode`
    - `bech32_decode`
    - `convertbits`
    - `decode`
    - `encode`
    
    Changes:
    - Added type hints using Python's `typing` module (`List`, `Tuple`, `Optional`).
    - No changes were made to the logic of any of the functions, ensuring that current functionality remains untouched.
    
    Motivation and Context:
    Adding type hints improves the developer experience by providing clearer signatures for each function. It removes ambiguity about what types the functions expect and return, helping anyone new to the codebase to understand it faster. These hints also assist static analysis tools like `mypy` to catch potential bugs or type issues.
    dollarparity authored Oct 3, 2024
    Configuration menu
    Copy the full SHA
    1be7415 View commit details
    Browse the repository at this point in the history