Update CONTRIBUTING.md

[ascillitoe]

Update CONTRIBUTING.md with a note on where to add class docstrings.

Will do the same for alibi and delete the contributing-update branch upon merge.

[codecov-commenter]

Codecov Report

Merging #595 (06ea59c) into master (0bbe586) will decrease coverage by 0.02%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #595      +/-   ##
==========================================
- Coverage   83.58%   83.55%   -0.03%     
==========================================
  Files         207      207              
  Lines       13838    13803      -35     
==========================================
- Hits        11566    11533      -33     
+ Misses       2272     2270       -2     

Impacted Files	Coverage Δ
alibi_detect/utils/_types.py	93.10% <0.00%> (-3.45%)	⬇️
alibi_detect/utils/missing_optional_dependency.py	94.28% <0.00%> (-0.16%)	⬇️
alibi_detect/datasets.py	69.19% <0.00%> (-0.14%)	⬇️
alibi_detect/saving/schemas.py	99.20% <0.00%> (-0.05%)	⬇️
alibi_detect/utils/fetching/fetching.py	0.00% <0.00%> (ø)
alibi_detect/cd/base.py	89.47% <0.00%> (+0.21%)	⬆️
alibi_detect/od/vae.py	90.36% <0.00%> (+1.07%)	⬆️

[mauicv]

Shall we add a note for those of us who now us VS-code on how to set up auto docstrings? 😆 I'm using this extension

[mauicv]

Otherwise LGTM! Although why was the docs CI cancelled?

[mauicv]

Actually another question: How do we document static classes or classes that don't implement an __init__ method? The similarity method backends do this for example.

[ascillitoe]

Shall we add a note for those of us who now us VS-code on how to set up auto docstrings? laughing I'm using this extension

Yuck... but yes good idea.

Otherwise LGTM! Although why was the docs CI cancelled?

I don't know... perhaps because I authored the PR via the github UI and it doesn't touch the codebase?

Actually another question: How do we document static classes or classes that don't implement an __init__ method? The similarity method backends do this for example.

Good question. Maybe the convention should be "add docstring in init if it exists, otherwise add to the class-level docstring"?

[ascillitoe]

@mauicv just updated following your comments.