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

[MRG] update docstring of ot.gromov.init_matrix #398

Merged
merged 1 commit into from
Sep 12, 2022

Conversation

decarpentierg
Copy link
Contributor

Types of changes

  • Update docstrings

Motivation and context / Related issue

The docstring of ot.gromov.init_matrix was not accurate. The documented parameters were C1, C2, T and p, although the function's parameters are C1, C2, p, q and loss_fun. The single commit of this PR fixes this issue.

How has this been tested (if it applies)

The modification cannot be tested.

PR checklist

  • I have read the CONTRIBUTING document.
  • The documentation is up-to-date with the changes I made (check build artifacts).
  • All tests passed, and additional code has been covered with new tests.
  • I have added the PR and Issue fix to the RELEASES.md file.

@codecov
Copy link

codecov bot commented Sep 12, 2022

Codecov Report

Merging #398 (c9ab282) into master (982c4a7) will increase coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #398      +/-   ##
==========================================
+ Coverage   93.94%   93.97%   +0.03%     
==========================================
  Files          22       22              
  Lines        5927     5927              
==========================================
+ Hits         5568     5570       +2     
+ Misses        359      357       -2     

@rflamary rflamary merged commit b295ffc into PythonOT:master Sep 12, 2022
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