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
get the simplest example working first then proceed to complexity
things to make sure to do
pytest set up to run tests and examples
type hinting in all functions/classes
pyproject.toml file to make it a package
basic and advanced functionalities implemented
all examples in scripts and no jupyter notebooks
github actions to run tests whenever main branch is being changed by PR or push
doc strings on all functions, e.g.
fromtypingimportOptionaldefsome_fun(a: float, b: str, c: Optional[bool]) ->float:
""" Calculates battery degradation in state of health (SOH) # Arguments - a: some argument - b: some other arg - ... # Returns - amount of SOH degradation """
The text was updated successfully, but these errors were encountered:
guidelines
things to make sure to do
The text was updated successfully, but these errors were encountered: