theochem / procrustes

Python library for finding the optimal transformation(s) that makes two matrices as close as possible to each other.

https://procrustes.qcdevs.org/

GNU General Public License v3.0

109 stars 20 forks source link

Add `pdsp` to documentation #186

Open FanwangM opened 2 years ago

FanwangM commented 2 years ago

This PR does a few things for documentation,

[x] Fix header level for accessing translation and scaling information
[x] Add and fix documentation for psdp module

FanwangM commented 2 years ago

Can you confirm that 6112464 is doing the right fix? The original documentation has a problem of equation rendering. Thank you. @banrovegrie

codecov[bot] commented 2 years ago

Codecov Report

Merging #186 (6112464) into master (48edbdc) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #186   +/-   ##
=======================================
  Coverage   94.48%   94.48%           
=======================================
  Files          11       11           
  Lines         671      671           
=======================================
  Hits          634      634           
  Misses         37       37

Impacted Files	Coverage Δ
procrustes/psdp.py	`96.96% <ø> (ø)`

banrovegrie commented 2 years ago

@FanwangM yeah it solves the rendering issue.

banrovegrie commented 2 years ago

Btw, what is this coverage report?

banrovegrie commented 2 years ago

@FanwangM lets keep this PR open for the documentation errors we might encounter while implementing the last algorithm as well. I guess we can keep rebasing this commits over the PRs that we merge.

FanwangM commented 2 years ago

Btw, what is this coverage report?

CodeCov provides a nice way of visualizing the testing coverage of the pull request and more details can be found at https://about.codecov.io/.

FanwangM commented 2 years ago

@FanwangM lets keep this PR open for the documentation errors we might encounter while implementing the last algorithm as well. I guess we can keep rebasing this commits over the PRs that we merge.

Yeah, we can wait for a while.