docs: add package-level docstrings

[pc532627]

Refs: 261

PR Type

• Documentation content changes

Description

Package level docstrings and headers added.

How Has This Been Tested?

N/A

Checklist before requesting a review

• I have made sure that my PR is not a duplicate.
• My code follows the style guidelines of this project.
• I have commented my code, particularly in hard-to-understand areas.
• I have performed a self-review of my code.
• I have made corresponding changes to the documentation.
• My changes generate no new warnings.
• I have added tests that prove my fix is effective or that my feature works.
• New and existing unit tests pass locally with my changes.
• Any dependent changes have been merged and published in downstream modules.

[tp832944]

This explains the top-level stuff nicely - thanks @pc532627. Before merging we have our outstanding discussion on terminology to resolve offline.

Please add the copyright header to tests/init.py.

[pc532627]

This explains the top-level stuff nicely - thanks @pc532627. Before merging we have our outstanding discussion on terminology to resolve offline.

Please add the copyright header to tests/init.py.

I've pushed some updates to address comments, leaving the PR open until terminology discussion is resolved.

[tp832944]

Terminology ok.