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

Make the syntax of example commands more consistent between the READMEs. #1188

Merged
merged 3 commits into from
Jan 9, 2024

Conversation

dlyongemallo
Copy link
Contributor

@dlyongemallo dlyongemallo commented Dec 30, 2023

Description

The various READMEs use slightly different (but equally valid) syntax for example conan and gcovr commands. This makes it a bit more difficult for a user to see the relationships between them, especially when looking at their command history after having followed the steps in the READMEs. This PR unifies the syntax to the predominant one (--param=value instead of --param value, and quotes around options which is required by zsh but optional in other shells).

Related issues

N/A

Checklist

  • I have performed a self-review of my code.
  • I have commented hard-to-understand parts of my code.
  • I have made corresponding changes to the public API documentation.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have updated the changelog with any user-facing changes.

Copy link
Collaborator

@cqc-alec cqc-alec left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I think we do need to keep the quotes around arguments containing asterisks, which are treated differently by zsh.

tket/README.md Outdated Show resolved Hide resolved
tket/README.md Outdated Show resolved Hide resolved
tket/README.md Outdated Show resolved Hide resolved
Consistently use `--param=value` instead of `--param value` and quotes around conan options (required by zsh, but optional in other shells).
@cqc-alec cqc-alec merged commit 009e15c into CQCL:develop Jan 9, 2024
28 checks passed
@dlyongemallo dlyongemallo deleted the tket_doc_conan branch January 9, 2024 18:15
cqc-alec added a commit that referenced this pull request Jan 17, 2024
* [infra] Fix determination of ccache path on Windows (#1192)

* Remove obsolete script. (#1179)

* Allow restriction of number of threads when building pytket using cmake. (#1180)

* Use PEP 600 manylinux containers to build pytket (#1194)

* [infra] Update versions of catch2 and rapidcheck. (#1190)

* Support python 3.12; drop python 3.9 (#1193)

* Only check pytket coverage for PRs to develop. (#1198)

* Revert "Unitary Synthesis of ChoiMixTableau for Diagonalisation (#941)"

This reverts commit ff68b3e.

Reverting because it caused significant regression in compilation
performance with
QuantinuumBackend.default_compilation_pass(optimisation_level=2) with
certain circuits composed of PauliExpBoxes.

* Bump tket version.

* Update changelog.

* Don't try to install ZX module with Python 3.12. (#1203)

* Bump tket version.

* Make the syntax of example commands more consistent between the READMEs. (#1188)

* [bugfix] Handle missing edge case in decomposition of `Rotation` (#1208)

* [feature] Accept `OpType.Phase` in circuits passed to `ZXGraphlikeOptimisation` (#1210)

* Update/copyright year (#1211)

* updtae copyright year

* update tket version

* update tket version II

* Don't build docs in release workflow. (#1212)

* Add missing `OpType.ConjugationBox` (#1209)

* Improve documentation of PassSelector. (#1214)

* Bump cachix/install-nix-action from 24 to 25 (#1216)

Bumps [cachix/install-nix-action](https://github.com/cachix/install-nix-action) from 24 to 25.
- [Release notes](https://github.com/cachix/install-nix-action/releases)
- [Commits](cachix/install-nix-action@v24...v25)

---
updated-dependencies:
- dependency-name: cachix/install-nix-action
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Alec Edgington <[email protected]>

* Update version and changelog.

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: David Yonge-Mallo <[email protected]>
Co-authored-by: cqc-melf <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants