Removing redundant note for doctest.

[vprusso]

Closes #650

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.7%. Comparing base (372c205) to head (c3111f3).
Report is 2 commits behind head on master.

Additional details and impacted files

@@          Coverage Diff           @@
##           master    #651   +/-   ##
======================================
  Coverage    97.7%   97.7%           
======================================
  Files         166     166           
  Lines        3250    3250           
  Branches      795     795           
======================================
  Hits         3176    3176           
  Misses         48      48           
  Partials       26      26           

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

[purva-thakre]

It appears all over the place, and I find this a bit distracting (especially when noted numerous times in the same tutorial, etc.)

I am fine with removing this if it is repeated across one page.

We should mention it once for the other pages. The things required by DOCTEST don't make sense for someone who is not familiar with why we are using something in the print output. What if they copy-paste an example into a local jupyter notebook? I had added it for this reason.

[vprusso]

It appears all over the place, and I find this a bit distracting (especially when noted numerous times in the same tutorial, etc.)

I am fine with removing this if it is repeated across one page.

We should mention it once for the other pages. The things required by DOCTEST don't make sense for someone who is not familiar with why we are using something in the print output. What if they copy-paste an example into a local jupyter notebook? I had added it for this reason.

That makes sense--I think having it at least in one place definitely makes sense. Maybe in the contribution guide?

[purva-thakre]

I think having it at least in one place definitely makes sense. Maybe in the contribution guide?

What if we create a section called Examples in the Getting Started section? We could introduce all the tutorials, point a user to the examples in the API as well as have a note for the things we use for DOCTEST.

Adding it to the contribution guide wouldn't be helpful for someone who is not interested in contributing to the project. Thoughts?

[purva-thakre]

Suggested change

	>>> np.around(entanglement_of_formation(rho), decimals=2)
	1.00
	>>> import numpy as np
	>>> np.around(entanglement_of_formation(rho), decimals=2)
	1.00

Sometimes np.around will round up to a higher number when we don't want it to. We don't see that here but when a function relies on optimization, np.around(0.8) gets rounded up to 1.0. This is why I did not use it.

[vprusso]

Yes, but this would only occur if you don't specify the number of decimals.

So, for instance:

np.around(0.66)
1.0

However

np.around(0.66, decimals=2)
0.66