Move references in docstrings #228
Conversation
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## master #228 +/- ##
======================================
Coverage 98.1% 98.1%
======================================
Files 295 295
Lines 6929 6929
Branches 773 773
======================================
Hits 6798 6798
Misses 90 90
Partials 41 41 ☔ View full report in Codecov by Sentry. |
docs/_autosummary/toqito.channel_metrics.completely_bounded_spectral_norm.rst
Show resolved
Hide resolved
purva-thakre
force-pushed
the
move_docstring_ref
branch
from
b2272c4
to
fc44299
Compare
purva-thakre
force-pushed
the
move_docstring_ref
branch
from
fc44299
to
c495af9
Compare
purva-thakre
force-pushed
the
move_docstring_ref
branch
from
a56d5d1
to
398ceaf
Compare
|
@vprusso Are you fine with how QETLAB is cited throughout the references? Thought I should double-check before I do the same for others.
|
Yep, I think that seems fine to me! |
|
Reopened this PR. The issue was with pybtex not being able to parse some URLs as URLs. For now, all the URLs that caused issues are strings. Will create a new issue for this. |
|
@vprusso This is ready for a review after resolving the conflicts. |
| @@ -6,20 +6,14 @@ | |||
|
|
|||
|
|
|||
| def completely_bounded_spectral_norm(phi: np.ndarray) -> float: | |||
| r""" | |||
| Compute the completely bounded spectral norm of a quantum channel. | |||
| r"""Compute the completely bounded spectral norm of a quantum channel. | |||
There was a problem hiding this comment.
Should the citations here be on the same line?
There was a problem hiding this comment.
Line length > 120 if I have the citations on the same line.
| @@ -12,23 +12,15 @@ def completely_bounded_trace_norm(phi: np.ndarray) -> float: | |||
| Find the completely bounded trace norm of a quantum channel. | |||
|
|
|||
| Also known as the completely bounded diamond norm of a quantum | |||
| channel [WatCNorm18]_. The algorithm in p.11 of [WatSDP09] with | |||
| implementation in QETLAB [JohQET] is used. | |||
| channel (Section 3.3.2 of :cite:`watrous_2018`). The algorithm in p.11 of :cite:`watrous2012simpler` with | |||
There was a problem hiding this comment.
Should we use a consistent bibtex key naming convention? For instance we have here watrous_2018 but then elsewhere we might have something like Watrous_2009_semidefinite. Perhaps we can agree upon on convention for consistency?
Something like {author-last-name}{year}{first-word-of-paper} so for instance, Watrous_2009_semidefinite would be watrous2009semidefinite?
There was a problem hiding this comment.
yes, I created a new issue for this #276 . I was lazy and mostly used what was provided in the bib info by arxiv because the changes are becoming too big to keep track of in this PR.
Co-authored-by: Vincent Russo <vincentrusso1@gmail.com>
| @@ -1,15 +1,16 @@ | |||
| #File for all article, arxiv and other web references | |||
| # To add a key, Lastname_year_abbreviatedtitle/firstletteroftitle | |||
There was a problem hiding this comment.
To add a key, Lastname_year_abbreviatedtitle/firstletteroftitle
@vprusso Would this work for the sake of consistency?
I did see your comment on this #228 (comment) but I would prefer to separate last name, year and first one/two words of title by underscore.
There was a problem hiding this comment.
We could align with how Google Scholar does bibtex keys, which is mostly what you have there. That is {lastname}{year}{abbreviatedtitle} Any opposition to that?
There was a problem hiding this comment.
I think I am going to create an issue for using Google scholar style for bibtex keys. I'll get to making these changes then.
Description
Fixes #191
Todos
Notable points that this PR has either accomplished or will accomplish.
Questions
Status