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
clizbe
changed the title
Add argument descriptions to all constraints scripts
Add argument descriptions to all "add contraints" functions
Aug 5, 2024
clizbe
changed the title
Add argument descriptions to all "add contraints" functions
Add argument descriptions to all "add constraints" functions
Aug 5, 2024
The arguments of all these functions should have been simplified to only require properly named arguments (connection, model, etc.). The docstrings will still need to be updated after the bulk of the refactor is done, but the arguments should now be clearer.
What and Why
The functions in the constraints folder should describe the arguments for the functions.
These files are:
Here's an example of the lack of argument documentation. What are the Ai, Ase, Fi, etc arguments?
Possible Drawbacks
No response
Related Issues
No response
The text was updated successfully, but these errors were encountered: