QuantumBFS / Yao.jl

Extensible, Efficient Quantum Algorithm Design for Humans.

Home Page:https://yaoquantum.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

lvignoli opened this issue · comments

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:

The following example switches to the X basis for measurement.
```jldoctest; setup=:(using Yao)
julia> reg = product_state(bit"110")
ArrayReg{2, ComplexF64, Array...}
active qubits: 3/3
nlevel: 2
```
"""
@interface measure

Oh, that is a good catch. Since this is a document fix, I pushed the commit to the master directly: b8a0cb2

Thank you for the report of document missing!

Thanks for the quick fix!