Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] fix typos #7

Merged
merged 1 commit into from
May 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ This package uses [typst-test](https://github.com/tingerrr/typst-test/) for runn
- `slice()` has no `dx` and `dy` parameters anymore. Instead, labels are handled through `label` exactly as in `gate()`. Also the `wires` parameter is replaced with `n` for consistency with other multi-qubit gates.
- Swap order of row and column parameters in `annotate()` to make it consistent with built-in Typst functions.
- Improvements:
- Improve layout (allow row/column spacing and min lengths to be specified in em-lenghts).
- Improve layout (allow row/column spacing and min lengths to be specified in em-lengths).
- Automatic bounds computation, even for labels.
- Improve meter (allow multi-qubit gate meters and respect global (per-circuit) gate padding).d
- Fixes:
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/quill-guide.typ
Original file line number Diff line number Diff line change
Expand Up @@ -482,7 +482,7 @@ Quill allows you to create totally customized gates by specifying the `draw-func

_Note, that the interface for custom gates might still change a bit. _

When the circuit is layed out, the draw function is called with two (read-only) arguments: the gate itself and a dictionary that contains information about the circuit style and more.
When the circuit is laid out, the draw function is called with two (read-only) arguments: the gate itself and a dictionary that contains information about the circuit style and more.

Let us look at a little example for a custom gate that just shows the vertical lines of the box but not the horizontal ones.

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/typst-doc.typ
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@
/// The function documentation dictionaries contain the keys
/// - `name`: The function name.
/// - `description`: The functions docstring description.
/// - `args`: A dictionary of info objects for each fucntion argument.
/// - `args`: A dictionary of info objects for each function argument.
///
/// These again are dictionaries with the keys
/// - `description` (optional): The description for the argument.
Expand Down
4 changes: 2 additions & 2 deletions src/gates.typ
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
/// - content (content): What to show in the gate (may be none for special gates like @@ctrl() ).
/// - x (auto, int): The column to put the gate in.
/// - y (auto, int): The row to put the gate in.
/// - fill (none, color): Gate backgrond fill color.
/// - fill (none, color): Gate background fill color.
/// - radius (length, dictionary): Gate rectangle border radius.
/// Allows the same values as the builtin `rect()` function.
/// - width (auto, length): The width of the gate can be specified manually with this property.
Expand Down Expand Up @@ -83,7 +83,7 @@
/// - y (auto, int): The row to put the gate in.
/// - target (none, int): If specified, a control wire is drawn from the gate up
/// or down this many wires counted from the wire this `mqgate()` is placed on.
/// - fill (none, color): Gate backgrond fill color.
/// - fill (none, color): Gate background fill color.
/// - radius (length, dictionary): Gate rectangle border radius.
/// Allows the same values as the builtin `rect()` function.
/// - width (auto, length): The width of the gate can be specified manually with this property.
Expand Down
2 changes: 1 addition & 1 deletion src/quill.typ
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
/// content or a string is given, the baseline will be adjusted auto-
/// matically to align with the center of it. One useful application is
/// `"="` so the circuit aligns with the equals symbol.
/// - circuit-padding (dictionary): Padding for the circuit (e.g., to accomodate
/// - circuit-padding (dictionary): Padding for the circuit (e.g., to accommodate
/// for annotations) in form of a dictionary with possible keys
/// `left`, `right`, `top` and `bottom`. Not all of those need to be
/// specified.
Expand Down
2 changes: 1 addition & 1 deletion src/quill2.typ
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
/// content or a string is given, the baseline will be adjusted auto-
/// matically to align with the center of it. One useful application is
/// `"="` so the circuit aligns with the equals symbol.
/// - circuit-padding (dictionary): Padding for the circuit (e.g., to accomodate
/// - circuit-padding (dictionary): Padding for the circuit (e.g., to accommodate
/// for annotations) in form of a dictionary with possible keys
/// `left`, `right`, `top` and `bottom`. Not all of those need to be
/// specified.
Expand Down
Loading