microsoft / microsoft/qdk

Make DumpMachine/DumpRegister output more compact and reduce use of Unicode symbols

Open
#1,699 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Rust
Stars
1k
Forks
212
Avg merge
3d 8h
Merged PRs (30d)
65

Description

**Is your feature request related to a problem? Please describe.**
1. DumpMachine output is very verbose. In my default screen layout, I can see one complete DumpMachine output with 4 basis states, anything extra requires scrolling. Our teleportation sample, for example, has 8 DumpMachine outputs, requiring a lot of scrolling, and the "DumpMachine:" headers and empty lines dominate the output.
2. Symbols ⟩ and 𝑖 are not recognized by a lot of editing environments (such as LaTeX), so copy-pasting DumpMachine output requires post-production.

**Describe the solution you'd like**
1. Remove "DumpMachine:" header from before the table of basis states, and some of the empty lines around it.
2. Replace 𝑖 with i in the complex number output. I don't think we can replace ⟩ as easily, using > is _very_ ugly, but having i in italic doesn't add a lot of visual value.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the DumpMachine and DumpRegister output entry points and compare their current formatting with the requested examples. Done means removing the DumpMachine header, reducing surrounding empty lines, and using a plain i in complex-number output while preserving the requested basis-state output.

Written by the indexing model from the issue text.

Assessment

Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.