Skip to content

[Typing] Trial PR: Adding Type Hints to Simple Functions in pybamm.models #4954

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

Open
JC230903 opened this issue Apr 5, 2025 · 1 comment

Comments

@JC230903
Copy link
Contributor

JC230903 commented Apr 5, 2025

Summary

As a preliminary contribution towards improving type coverage in PyBaMM, I'd like to submit a small PR that adds type hints to simpler models inside the pybamm.models module.

Scope

This trial PR will focus on:

  • Helper functions that return basic types.
  • Small class methods with simple input/output signatures.

Reference

This will follow a similar approach to PR #3578, and aligns with the proposal I’m currently preparing for GSoC 2025.

Motivation

I’d like to familiarize myself with PyBaMM’s contribution process and get early feedback from the community on type hinting conventions, review expectations, and structure.

Questions

  • Are there any specific files or submodules you'd recommend I start with?
@JC230903
Copy link
Contributor Author

JC230903 commented Apr 5, 2025

cc @agriyakhetarpal

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

Successfully merging a pull request may close this issue.

1 participant