Update API docstrings

[skasberger]

Update docstrings from the api module.

Prepare

• [ ] Read other docstring conventions and practices
• [ ] Define docstring convention
• [ ] Check: docstrings
  • [ ] code linting
  • [ ] testing

Implementation

• [ ] Update docstrings
  • [ ] get_children: that parent node is not collected. or update function to collect the parent node to. pass parameter for this!
• [ ] Update Docs: add docstrings convention to Contributor Guide
• [ ] Run pytest
• [ ] Run tox

Review

• [ ] Docs

Follow-Ups

• [ ] Update models docstrings
• [ ] Update utils docstrings

[pdurbin]

As discussed during the 2024-02-14 meeting of the pyDataverse working group, we are closing old milestones in favor of a new project board at https://github.com/orgs/gdcc/projects/1 and removing issues (like this one) from those old milestones. Please feel free to join the working group! You can find us at https://py.gdcc.io and https://dataverse.zulipchat.com/#narrow/stream/377090-python