Updated docstrings

[apearsonn]

Updated docstrings in the following format:

"""
function()
Description of function.
 Arguments
- 'x'
- 'y'
- 'z'

 Keywords
- 'x'

 Returns
- 'x'

"""

There are still functions that need arguments, keywords, returns or a description added. All of the missing descriptions are found in this Google Doc.
https://docs.google.com/document/d/1-clJFUV2ZZ8kklChEZ_7bfOK89VDA-6_WGYy7SodkRs/edit?usp=sharing

[fhagemann]

This PR seems to (re)introduce two functions (not sure if we want them out):
f_optimize_ctc and get_n_after_aoe_cut. Do we need/want them?

[fhagemann]

The failing tests seem to be unrelated (can we fix that??)

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.

Project coverage is 21.33%. Comparing base (7ff7aac) to head (6d7a596).

Files with missing lines	Patch %	Lines
src/peakshapes.jl	0.00%	3 Missing ⚠️
src/aoe_cut.jl	0.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #80   +/-   ##
=======================================
  Coverage   21.33%   21.33%           
=======================================
  Files          36       36           
  Lines        3305     3305           
=======================================
  Hits          705      705           
  Misses       2600     2600           

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

[fhagemann]

Someone else should judge the verbosity of the argument descriptions.