Skip to content

Commit

Permalink
Improve docs (#16)
Browse files Browse the repository at this point in the history
Adds comments added to #8 after it was merged.
  • Loading branch information
Gistbatch authored Dec 10, 2024
1 parent 354e56b commit e51df88
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The `tqecd` package is a spin-off from the [`tqec`](https://github.com/tqec/tqec) package that allows the automatic search of detectors in structured quantum error correction circuits.

This package was initially part of `tqec`, and has been outsourced to make it accessible to anyone wanting to use it outside of the `tqec` library.
This package was initially part of `tqec` and has been outsourced to make it accessible to anyone wanting to use it outside of the `tqec` library.

## Documentation

Expand All @@ -16,7 +16,7 @@ Currently, `tqecd` needs to be installed from source using
python -m pip install git+https://github.com/tqec/tqecd.git
```

The `tqecd` package have some dependencies that might be harder than a simple `pip install` to install. If you end up having any issue with the simple installation method above, please have a look at the [full installation page](https://tqec.github.io/tqecd/user_guide/installation.html).
The `tqecd` package has some dependencies that might be harder to install than a simple `pip install`. If you have any issues with the simple installation method above, please look at the [full installation page](https://tqec.github.io/tqecd/user_guide/installation.html).

## Basic usage

Expand Down Expand Up @@ -76,4 +76,4 @@ DETECTOR(1, 1, 0) rec[-1]

Pull requests and issues are more than welcomed!

See the [contributing page](https://tqec.github.io/tqecd/contributor_guide.html) for for specific instructions to start contributing.
See the [contributing page](https://tqec.github.io/tqecd/contributor_guide.html) for specific contributing instructions.
4 changes: 2 additions & 2 deletions docs/user_guide/quick_start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Build your quantum circuit
The first step to use ``tqecd`` is to build a compatible quantum circuit.

In short, compatible quantum circuits should be sequences of blocks that all follow the
same scheme: starts by a possibly empty sequence of resets, continues by a possibly empty
same scheme: they start with a possibly empty sequence of resets, continue by a possibly empty
sequence of "computation gates" (i.e., any gate that is not a reset or a measurement) and
ends with a non-empty sequence of measurements.
end with a non-empty sequence of measurements.

.. code-block:: python
Expand Down

0 comments on commit e51df88

Please sign in to comment.