search

E3SM-Project / polaris

Testing and analysis for OMEGA, MPAS-Ocean, MALI and MPAS-Seaice
BSD 3-Clause "New" or "Revised" License
6 stars 13 forks source link

Add docstrings to deploy package #220

Closed altheaden closed 2 months ago

altheaden commented 2 months ago

In this PR, I added docstrings to the functions in the deployment package. I added short docstrings for private functions and more detailed ones for public functions.

altheaden commented 2 months ago

@xylar some of these docstrings are a little sparse, so can you let me know if there are any you would like me to explain in more detail? And in general, let me know if I said the wrong thing for any of them and I'll fix it.

altheaden commented 2 months ago

Those are good changes, I will update this now.

altheaden commented 2 months ago

Stand by, I needed to push to do linting and testing on PM since I was working on my mac

xylar commented 2 months ago

@altheaden, apologies for going ahead and committing the fix but I assume you're probably done for the day and I wanted to nudge things along.

altheaden commented 2 months ago

@xylar No worries! I am not quite done but I wasn't making much headway with this so that's totally fine. Thanks for fixing it!