Formatted docstrings in files to pass with pydocstyle's criteria. - #72

Merged

jacobbieker merged 19 commits into

openclimatefix:mainfrom

Averagenormaljoe:main

Mar 28, 2025

Commits on Mar 24, 2025

feat: added docstrings to functions in the metnet folder and split commennts into separate lines to adhere the requirements specified by ruff
andrewTheCommitter
committed
feat: added more placeholder doc strings
andrewTheCommitter
committed

Commits on Mar 25, 2025

feat: added docstrings to the 'layers/ConvGRU.py' file
andrewTheCommitter
committed
feat: added docstrings to the 'layers/ConvGRU.py' file
andrewTheCommitter
committed
feat: added doc strings to the remaining functions to adhere to ruff requirements
andrewTheCommitter
committed
feat: in 'layers/ConvGRU.py' changed 'l' variable name to 'layer_index' in the 'foward' and '__init__' function to handle ambiguous variable name in ruff
andrewTheCommitter
committed
feat: added args to several docstrings
andrewTheCommitter
committed
feat: adding periods to docstrings in the file
andrewTheCommitter
committed
feat: added periods to docstrings to comply with pydocstyle
andrewTheCommitter
committed
feat: added the periods and adjusted single line docs in layers files in models to adhere to requirements of pydocstyles
andrewTheCommitter
committed
feat: changed the files in the repository to meet the requirements of metnet
andrewTheCommitter
committed
feat: added a period to docstring in 'setup.py' and reformated the files using black
andrewTheCommitter
committed

Commits on Mar 27, 2025