DOC Fix various documentation formatting inconsistencies

[romanlutz]

Description

We had several inconsistently formatted files, so this PR addresses a bunch of them. The idea is to have the class docstring explain the purpose of the class and the constructor docstring provide constructor args. So far, we occasionally had constructor args in both which leads to duplication and inevitably things get out of sync. I've fixed such an instance here as well.

There are also a few miscellaneous fixes in comments.

Areas changed

npm packages changed:

• responsibleai/causality
• responsibleai/core-ui
• responsibleai/counterfactuals
• responsibleai/dataset-explorer
• responsibleai/fairness
• responsibleai/interpret
• responsibleai/localization
• responsibleai/mlchartlib
• responsibleai/model-assessment

Python packages changed:

• raiwidgets
• responsibleai
• erroranalysis
• rai_core_flask

Tests

• No new tests required.
• New tests for the added feature are part of this PR.
• I validated the changes manually.

Screenshots (if appropriate):

Documentation:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.

[codecov-commenter]

Codecov Report

Merging #1209 (4e5ecaf) into main (23435ce) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1209   +/-   ##
=======================================
  Coverage   66.94%   66.94%           
=======================================
  Files          91       91           
  Lines        4359     4359           
=======================================
  Hits         2918     2918           
  Misses       1441     1441           

Flag	Coverage Δ
unittests	66.94% <ø> (ø)

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

Impacted Files	Coverage Δ
...ranalysis/erroranalysis/_internal/cohort_filter.py	89.51% <ø> (ø)
...is/erroranalysis/_internal/surrogate_error_tree.py	92.51% <ø> (ø)
...onsibleai/responsibleai/managers/causal_manager.py	96.09% <ø> (ø)
...i/responsibleai/managers/counterfactual_manager.py	94.15% <ø> (ø)
...i/responsibleai/managers/error_analysis_manager.py	89.77% <ø> (ø)
...ibleai/responsibleai/managers/explainer_manager.py	68.42% <ø> (ø)
...sibleai/responsibleai/rai_insights/rai_insights.py	77.81% <ø> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 23435ce...4e5ecaf. Read the comment docs.

[riedgar-ms]

This block is duplicated in the constructor, I assume?

[romanlutz]

Yes!

[github-actions]

https://responsibleai.blob.core.windows.net/pullrequest/microsoft/responsible-ai-toolbox/romanlutz/doc_formatting/dashboard/index.html