Document `LogicalCounts`
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1k
- Forks
- 212
- Avg merge
- 3d 8h
- Merged PRs (30d)
- 65
Description
Hi all! I noticed the expected keys for `LogicalCounts` https://github.com/microsoft/qsharp/blob/fc6ec5bccac1e74dbffe5be6d78a00394b177dd8/pip/qsharp/estimator/_estimator.py#L1026 are not actually documented https://learn.microsoft.com/en-us/python/qsharp/qsharp.estimator.logicalcounts?view=qsharp-py
It would be nice to have a reference doc that lists the expected keys (i.e. what we're expected to count).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the LogicalCounts definition in pip/qsharp/estimator/_estimator.py around line 1026 and compare it with the existing Microsoft Learn qsharp.estimator.logicalcounts reference. Document the expected keys and what is expected to be counted; done means the reference page lists the keys from the implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100