QuantumBFS / Yao.jl

Extensible, Efficient Quantum Algorithm Design for Humans.
https://yaoquantum.org
Other
924 stars 122 forks source link

Incomplete docstring for `measure`: missing custom basis measurement example #401

Closed lvignoli closed 2 years ago

lvignoli commented 2 years ago

See https://docs.yaoquantum.org/dev/man/registers.html#YaoAPI.measure in the docs. The example for measuring in a custom basis is cropped.

The docstring is indeed incomplete:

https://github.com/QuantumBFS/Yao.jl/blob/15eb406feaf40e7eb4f0ffaa956aef0b138917c5/lib/YaoAPI/src/registers.jl#L412-L422

GiggleLiu commented 2 years ago

Oh, that is a good catch. Since this is a document fix, I pushed the commit to the master directly: https://github.com/QuantumBFS/Yao.jl/commit/b8a0cb2c73ab002e89c7a584e5c753a5c7113465

Thank you for the report of document missing!

lvignoli commented 2 years ago

Thanks for the quick fix!