Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pdsp to documentation #186

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Conversation

FanwangM
Copy link
Collaborator

@FanwangM FanwangM commented Sep 2, 2022

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
Copy link
Collaborator Author

FanwangM commented Sep 2, 2022

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

@codecov
Copy link

codecov bot commented Sep 2, 2022

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
Member

@FanwangM yeah it solves the rendering issue.

@banrovegrie
Copy link
Member

Btw, what is this coverage report?

@banrovegrie
Copy link
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
Copy link
Collaborator Author

FanwangM commented Sep 2, 2022

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
Copy link
Collaborator Author

FanwangM commented Sep 2, 2022

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

None yet

2 participants