Add class docstring for DiffractionObject

[bobleesj]

Closes #240 - DiffractionObject docstring do over

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.68%. Comparing base (ce6c9cc) to head (90672ee).
Report is 21 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##              main     #265      +/-   ##
===========================================
- Coverage   100.00%   98.68%   -1.32%     
===========================================
  Files            8        8              
  Lines          404      379      -25     
===========================================
- Hits           404      374      -30     
- Misses           0        5       +5     

see 4 files with indirect coverage changes

[bobleesj]

@sbillinge ready for review - cc'ing @yucongalicechen

[sbillinge]

this is fantastic! Few small comments inline then we can merge.

[sbillinge]

Let's use the numpy standard. First line is <80 chars and gives a high level statement of the purpose.

Then a blank line. then a more meaty description such as you have here).

[bobleesj]

done - do we want to use automatic doc formatting in pre-commit?

  # docformatter - formats docstrings in python code
  - repo: https://github.com/s-weigand/docformatter
    rev: 5757c5190d95e5449f102ace83df92e7d3b06c6c
    hooks:
      - id: docformatter
        additional_dependencies: [tomli]
        args: [--in-place, --config, ./pyproject.toml]

??

This basically modifies our code to PEP 257, although it does not fix the length, it does change the format.

REF: https://github.com/PyCQA/docformatter

[bobleesj]

Like black, it first fails, and the modify it automatically for us.

[bobleesj]

(i can create a separate PR for this)

[bobleesj]

@sbillinge ready for review - some comments are "outdated" and no longer displayed under Files changed but please refer to my latest replies above

[bobleesj]

(fixed a quick typo)