Skip to content

Add pdsp to documentation - #186

Open
FanwangM wants to merge 3 commits into
theochem:master-backupfrom
FanwangM:upd_docs
Open

FanwangM wants to merge 3 commits into
theochem:master-backupfrom
FanwangM:upd_docs

Conversation

@FanwangM

@FanwangM FanwangM commented Sep 2, 2022

Copy link
Copy Markdown
Collaborator

This PR does a few things for documentation,

  • Fix header level for accessing translation and scaling information
  • Add and fix documentation for psdp module

The original notebook will show the example and accessing
translation and scaling information at the same header level,
which is not right.
@FanwangM

FanwangM commented Sep 2, 2022

Copy link
Copy Markdown
Collaborator Author

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

@codecov

codecov Bot commented Sep 2, 2022

Copy link
Copy Markdown

Codecov Report

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

Impacted file tree graph

@@           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

Copy link
Copy Markdown
Member

@FanwangM yeah it solves the rendering issue.

@banrovegrie

Copy link
Copy Markdown
Member

Btw, what is this coverage report?

@banrovegrie

Copy link
Copy Markdown
Member

@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

FanwangM commented Sep 2, 2022

Copy link
Copy Markdown
Collaborator Author

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

FanwangM commented Sep 2, 2022

Copy link
Copy Markdown
Collaborator Author

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants