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

Fix math rendering in some docsstrings of the quantum_info module #1441

Merged
merged 11 commits into from
Sep 13, 2024

Conversation

renatomello
Copy link
Contributor

@renatomello renatomello commented Sep 10, 2024

Checklist:

  • Reviewers confirm new code works as expected.
  • Tests are passing.
  • Coverage does not decrease.
  • Documentation is updated.

@renatomello renatomello added the documentation Improvements or additions to documentation label Sep 10, 2024
@renatomello renatomello added this to the Qibo 0.2.12 milestone Sep 10, 2024
@renatomello renatomello self-assigned this Sep 10, 2024
@renatomello renatomello changed the title Fix math rendering in the docsstring of quantum_info.entropies.classical_relative_entropy Fix math rendering in some docsstrings of quantum_info module Sep 10, 2024
@renatomello renatomello changed the title Fix math rendering in some docsstrings of quantum_info module Fix math rendering in some docsstrings of the quantum_info module Sep 10, 2024
Copy link
Contributor

@MatteoRobbiati MatteoRobbiati left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I confirm now it renders properly.

@renatomello renatomello added the quantum_info module PRs and issues related to the quantum information module label Sep 10, 2024
@renatomello renatomello mentioned this pull request Sep 11, 2024
4 tasks
Copy link

codecov bot commented Sep 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.10%. Comparing base (218f298) to head (5a7fe1e).
Report is 12 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1441   +/-   ##
=======================================
  Coverage   97.10%   97.10%           
=======================================
  Files          81       81           
  Lines       11653    11653           
=======================================
  Hits        11316    11316           
  Misses        337      337           
Flag Coverage Δ
unittests 97.10% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@MatteoRobbiati MatteoRobbiati left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Is the choice of the notation $|v)$ common? Just curiosity :)

@renatomello
Copy link
Contributor Author

renatomello commented Sep 12, 2024

Thanks! Is the choice of the notation | v ) common? Just curiosity :)

yes, either that or double kets like $$|A\rangle\rangle$$

@alecandido
Copy link
Member

alecandido commented Sep 12, 2024

yes, either that or double kets like | A ⟩⟩

I've also seen the double kets somewhere in the docs. Should we keep just one or the other?

@renatomello
Copy link
Contributor Author

yes, either that or double kets like | A ⟩⟩

I've also seen the double kets somewhere in the docs. Should we keep just one or the other?

Done

@alecandido
Copy link
Member

Done

Thanks @renatomello!

@renatomello renatomello added this pull request to the merge queue Sep 13, 2024
Merged via the queue into master with commit 33efb91 Sep 13, 2024
27 checks passed
@renatomello renatomello deleted the doc_fix branch September 13, 2024 05:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation quantum_info module PRs and issues related to the quantum information module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants