update docstrings and documentation consistent

[superstar54]

fix #496

[superstar54]

Hi @PNOGillespie, thanks for the valuable feedback. Could you please check this PR and see if it makes the text clearer to the user?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.85%. Comparing base (15abd2b) to head (13fc4c3).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #649   +/-   ##
=======================================
  Coverage   75.85%   75.85%           
=======================================
  Files          60       60           
  Lines        4312     4312           
=======================================
  Hits         3271     3271           
  Misses       1041     1041           

Flag	Coverage Δ
python-3.10	75.85% <ø> (ø)
python-3.9	75.88% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

[PNOGillespie]

Hi @superstar54, this seems reasonable to me. I've suggested a small correction to the first docstring, but overall this does address the point I raised in the Issue page - nice work.

[superstar54]

Thanks @PNOGillespie , I adapted your suggestion.

[PNOGillespie]

All good for me @superstar54, nice work.