fix: resolve numpydoc docstring warnings #547

[MdSayemkhan]

• Convert function summaries to infinitive verb form
• Fix parameter and return value descriptions
• Make docstrings more concise and accurate

Fixes #547

Contributor checklist

• This pull request is on a separate branch and not the main branch
• I have tested my code with the pytest command as directed in the testing section of the contributing guide

---

Description

Related issue

• Fix all numpydoc docstring warnings #547

[github-actions]

Thank you for the pull request!

The Scribe team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Data rooms once you're in. Also consider joining our bi-weekly Saturday dev syncs. It'd be great to have you!

Maintainer checklist

• The linting and formatting workflow within the PR checks do not indicate new errors in the files changed

• The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

[github-actions]

First PR Commit Check

• The commit messages for the remote branch of a new contributor should be checked to make sure their email is set up correctly so that they receive credit for their contribution
  • The contributor's name and icon in remote commits should be the same as what appears in the PR
  • If there's a mismatch, the contributor needs to make sure that the email they use for GitHub matches what they have for git config user.email in their local Scribe-Data repo (can be set with git config --global user.email "GITHUB_EMAIL")

[andrewtavis]

Amazing to get some help here, @MdSayemkhan! I'll try to check this later 😊

[andrewtavis]

I'd prefer to keep these spaces so the docstrings aren't as dense :) For me makes it easier to read them 😊

[andrewtavis]

Let's comment this out for now so we're not blocking others, and we can turn it back on as we work on this?

[andrewtavis]

So far some amazing progress here, @MdSayemkhan! I'll bring this in and then we can work on some of the other warnings? You'd be very welcome to continue on this if you'd have interest!