festim-dev / festim-dev/FESTIM
Rename `GenericReaction` with `MassActionReaction` and `ReactionBase` with `GenericReaction`
- Dominant language
- Python
- Stars
- 135
- Forks
- 45
- Avg merge
- 3d 11h
- Merged PRs (30d)
- 16
Description
in `2.2rc2`:
`GenericReaction`'s specificity is that it follows mass action. It should be rename to reflect that.
On the other hand `ReactionBase` could imply that it's a base (`ABC`) class which shouldn't be instanciated but only inheritied from. Which is not the case. This class _really is_ generic and should be renamed.
@jhdark do you agree?
Contributor guide
No contributing guide indexed for this repository
Research direction
Locate the definitions and all references to `GenericReaction` and `ReactionBase` in the Python project, including any tests or documentation. Rename the classes to match their intended meanings—`MassActionReaction` and `GenericReaction`—update references, and run the existing test suite to confirm the renamed API works.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100