dwave-neal icon indicating copy to clipboard operation
dwave-neal copied to clipboard

SimulatedAnnealingSampler.sample method return type incorrectly documented

Open CrashAndSideburns opened this issue 3 years ago • 1 comments

Description The return type of the SimulatedAnnealingSampler.sample method is said to be "a dimod Response object" in the docs, a class which is nowhere documented in the neal or dimod docs.

To Reproduce View here.

Expected Behaviour The documentation should be changed to reflect that actual return type of SimulatedAnnealingSampler.sample, namely SampleSet.

Environment: N/A

CrashAndSideburns avatar Jul 12 '22 18:07 CrashAndSideburns

Agree! Thanks for the bug report!

arcondello avatar Jul 12 '22 18:07 arcondello

Fixed.

randomir avatar Jan 26 '23 13:01 randomir