Documentation & Typing Part 1

[ZackAttack614]

Overview

This PR is the first of many which will add docstrings and typing to the HEXRD library.

Affected Workflows

No workflows are affected by this PR.

Documentation Changes

This PR adds explicit documentation for functions in a few places, including argument types and descriptors. It also adds static type identifiers to a number of variables, parameters, and return types for clarity.

[codecov]

Codecov Report

❌ Patch coverage is 79.89418% with 114 lines in your changes missing coverage. Please review.
✅ Project coverage is 69.86%. Comparing base (3fd72b3) to head (3d304a6).
⚠️ Report is 3 commits behind head on master.

Files with missing lines	Patch %	Lines
hexrd/core/instrument/hedm_instrument.py	47.32%	59 Missing ⚠️
hexrd/core/material/crystallography.py	89.34%	13 Missing ⚠️
hexrd/core/imageseries/load/eiger_stream_v1.py	20.00%	12 Missing ⚠️
hexrd/hedm/xrdutil/utils.py	46.15%	7 Missing ⚠️
hexrd/core/imageseries/load/__init__.py	84.21%	3 Missing ⚠️
hexrd/core/instrument/detector.py	88.46%	3 Missing ⚠️
hexrd/core/material/utils.py	25.00%	3 Missing ⚠️
...d/core/fitting/calibration/lmfit_param_handling.py	85.71%	2 Missing ⚠️
hexrd/core/material/spacegroup.py	66.66%	2 Missing ⚠️
hexrd/core/transforms/new_capi/xf_new_capi.py	86.66%	2 Missing ⚠️
... and 8 more

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #884      +/-   ##
==========================================
+ Coverage   69.78%   69.86%   +0.07%     
==========================================
  Files         146      146              
  Lines       22161    22193      +32     
==========================================
+ Hits        15466    15506      +40     
+ Misses       6695     6687       -8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[psavery]

Haven't had a chance to review everything yet. But here are some comments so far. I'll try to review more soon!

[psavery]

Please run black on the codebase after making the rest of the changes.

[psavery]

LGTM