standardize docstrings

[adamgayoso]

No description provided.

[codecov]

Codecov Report

Merging #30 (4fe7862) into main (e189453) will increase coverage by 0.13%.
The diff coverage is 95.83%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #30      +/-   ##
==========================================
+ Coverage   94.31%   94.44%   +0.13%     
==========================================
  Files          11       12       +1     
  Lines         422      432      +10     
==========================================
+ Hits          398      408      +10     
  Misses         24       24              

Flag	Coverage Δ
unittests	94.44% <95.83%> (+0.13%)	⬆️

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

Impacted Files	Coverage Δ
src/scib_metrics/_isolated_labels.py	97.05% <ø> (ø)
src/scib_metrics/_silhouette.py	96.29% <ø> (ø)
src/scib_metrics/utils/_dist.py	100.00% <ø> (ø)
src/scib_metrics/utils/_silhouette.py	98.57% <ø> (ø)
src/scib_metrics/_utils.py	87.50% <87.50%> (ø)
src/scib_metrics/_ari_nmi.py	94.11% <100.00%> (+1.96%)	⬆️
src/scib_metrics/_lisi.py	94.59% <100.00%> (+0.30%)	⬆️

[justjhong]

X feels weird to me (thinking more adj_mtx, but also for LISI it would bug out on non-KNN adj mtxes bc there would be uneven number of neighbors), but u do u

[justjhong]

theres a types file for this i thought

[adamgayoso]

You are right we should have one variable name for knn graphs and one for embeddings

Maybe we should use embedding and neighbor_distances and neighbor_connectivities explictly?