397 standardise docstrings

[sophie22]

Add a description for every function in hazen task scripts in consistent Google style to enable automated generation of documentation using Sphinx and ReadTheDocs

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
hazenlib
ACRObject.py	107	11	90%	92, 95–97, 102–105, 143, 199–202
HazenTask.py	28	3	89%	43–47
__init__.py	56	15	73%	173, 205–214, 216–225, 227–229, 246–250, 254
exceptions.py	21	5	76%	19–23, 42
utils.py	189	43	77%	72, 76, 86, 91, 130, 137–150, 161, 168–175, 195–197, 215–219, 238–242, 251, 256, 267, 319, 322, 330–335, 338, 385, 394, 409
hazenlib/tasks
acr_geometric_accuracy.py	119	62	48%	54–101, 119–165, 186–255
acr_ghosting.py	107	42	61%	46–62, 105–107, 159–161, 211–293
acr_slice_position.py	136	48	65%	59–83, 286–353
acr_slice_thickness.py	136	60	56%	48–67, 238–322
acr_snr.py	134	58	57%	47, 62–113, 132, 227–242, 283–301, 348–373
acr_spatial_resolution.py	207	68	67%	69–100, 188, 286, 303–314, 460–539
acr_uniformity.py	81	32	60%	47–64, 148–200
ghosting.py	149	51	66%	28–47, 67, 171–172, 179, 196–197, 252–256, 271–275, 346–387
relaxometry.py	290	89	69%	210–211, 213, 226–231, 238–246, 277–326, 375, 409–431, 609, 655–659, 726, 811–833, 851–866
slice_position.py	124	40	68%	30, 43–71, 129–130, 157, 273, 283–306
slice_width.py	351	53	85%	44–48, 52, 123, 188–213, 383, 555, 560–561, 567, 572, 648–649, 1021–1085
snr.py	173	69	60%	45–48, 87, 103–113, 206–225, 237–247, 287–302, 330–340, 345–361, 399–415, 428–434, 477–495
snr_map.py	107	1	99%	157
spatial_resolution.py	246	45	82%	50–54, 58, 90, 191, 213, 294, 460–503
uniformity.py	80	19	76%	59–63, 67, 118–119, 126, 175–205
TOTAL	2866	814	72%

Tests	Skipped	Failures	Errors	Time
198	0 💤	0 ❌	0 🔥	2m 15s ⏱️

[sophie22]

All functions in MagNet task scripts have at least a placeholder docstring in the Google format.

[sophie22]

All functions in ACR task scripts have at least a placeholder docstring in the Google format.

[tomaroberts]

Great start on getting these docstrings filled out.

Just a few comments.

PR is still in draft btw, if you want to undraft it.

[sophie22]

pls don't delete the branch