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

Rename "positive electrode diffusivity" to "positive particle diffusivity"? #3229

Closed
valentinsulzer opened this issue Aug 3, 2023 · 4 comments · Fixed by #3624
Closed

Rename "positive electrode diffusivity" to "positive particle diffusivity"? #3229

valentinsulzer opened this issue Aug 3, 2023 · 4 comments · Fixed by #3624
Assignees
Labels
difficulty: easy A good issue for someone new. Can be done in a few hours priority: medium To be resolved if time allows

Comments

@valentinsulzer
Copy link
Member

valentinsulzer commented Aug 3, 2023

It's a better name, but a breaking change so maybe not worth it.
We can make it not breaking by returning "positive particle diffusivity" from parameter_values["Positive electrode diffusivity"] with a deprecation warning

@brosaplanella
Copy link
Member

Non-breaking change with deprecation warning sounds good to me.

@rtimms
Copy link
Contributor

rtimms commented Aug 4, 2023

Agreed.

@valentinsulzer valentinsulzer added difficulty: easy A good issue for someone new. Can be done in a few hours priority: medium To be resolved if time allows labels Aug 7, 2023
@ejfdickinson
Copy link

"Positive electrode particle diffusivity" feels more correct albeit more verbose. What's a 'positive particle'..?

@valentinsulzer
Copy link
Member Author

I think "positive particle" is fairly self-explanatory, we already have a bunch of variables like "Positive particle concentration"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: easy A good issue for someone new. Can be done in a few hours priority: medium To be resolved if time allows
Projects
7 participants