Adding documentation to functions

[Mochatr]

Description

Issue number and link

Testing plan

Author checklist

• [x] I have submitted a Contributor License Agreement
• [ ] I have added my name to CONTRIBUTORS.md
• [ ] I have updated CHANGES.md with a short summary of my change
• [ ] I have added or updated unit tests to ensure consistent code coverage
• [x] I have updated the inline documentation, and included code examples where relevant
• [x] I have performed a self-review of my code

[github-actions[bot]]

Thank you for the pull request, @Mochatr!

:white_check_mark: We can confirm we have a CLA on file for you.

[ggetz]

Hi @Mochatr! Though I do agree the build script could use more inline documentation, I'm curious what your intended use case for these functions are? That may help us frame how these comments are structured.

[ggetz]

I'm closing this issue due to inactivity. If you believe this is still an issue, please feel free to re-open. Thanks!