From 6516885961aea586f558ecc55e9d8355ca1ad250 Mon Sep 17 00:00:00 2001 From: INNAN Nouhaila <64653897+Innanov@users.noreply.github.com> Date: Thu, 1 Jun 2023 07:52:04 +0100 Subject: [PATCH] Fixing some typos (#1827) * Update aer_densitymatrix.py * Update aer_statevector.py * Update README.md * Update CONTRIBUTING.md --------- Co-authored-by: Hiroshi Horii --- CONTRIBUTING.md | 18 +++++++++--------- README.md | 10 +++++----- .../quantum_info/states/aer_densitymatrix.py | 2 +- .../quantum_info/states/aer_statevector.py | 2 +- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e33c2700d0..59d1bdb829 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,8 +20,8 @@ please ensure that: which will run these checks and report any issues. If your code fails the local style checks, you can use `tox -eblack` - and `tox -eclang` to automatically fix update the code formatting - in python and C++ respectively. + and `tox -eclang` to automatically fix and update the code formatting + in python and C++, respectively. 2. The documentation has been updated accordingly. In particular, if a function or class has been modified during the PR, please update the @@ -39,7 +39,7 @@ automation. This works through a combination of the git log and the pull request. When a release is tagged and pushed to GitHub, the release automation bot looks at all commit messages from the git log for the release. It takes the PR numbers from the git log (assuming a squash merge) and checks if that PR had -a `Changelog:` label on it. If there is a label it will add the git commit +a `Changelog:` label on it. If there is a label, it will add the git commit message summary line from the git log for the release to the changelog. If there are multiple `Changelog:` tags on a PR, the git commit message summary @@ -69,7 +69,7 @@ understand if they need to update their program which uses Qiskit, and how they would go about doing that. It ideally should explain why they need to make this change too, to provide the necessary context. -To make sure we don't forget a release note or if the details of user-facing +To make sure we don't forget a release note if the details of user-facing changes over a release cycle, we require that all user facing changes include documentation at the same time as the code. To accomplish this, we use the [reno](https://docs.openstack.org/reno/latest/) tool which enables a git-based @@ -193,14 +193,14 @@ particular will be located at `docs/_build/html/release_notes.html` ## Style and lint -Qiskit Aer uses 3 tools for verify code formatting and lint checking. The +Qiskit Aer uses 3 tools for verifying code formatting and lint checking. The first tool is [black](https://github.com/psf/black) which is a Python code formatting tool that will automatically update the code formatting to a consistent style. The second tool is [pylint](https://www.pylint.org/) which is a code linter which does a deeper analysis of the Python code to find both style issues and potential bugs and other common issues in Python. The third tool is [clang-format](https://clang.llvm.org/docs/ClangFormat.html) which is a -C++ code formatting tool that will automatically update codes with a consitent style. +C++ code formatting tool that will automatically update codes with a consistent style. You can check that your local modifications conform to the style rules by running `tox -elint` which will run `black`, `pylint` and `clang-format` @@ -240,7 +240,7 @@ When it is time to release a new minor version of qiskit-aer, we will: 1. Create a new tag with the version number and push it to github 2. Change the `main` version to the next release version. -The release automation processes will be triggered by the new tag and perform +The release automation processes will be triggered by the new tag and will perform the following steps: 1. Create a stable branch for the new minor version from the release tag @@ -463,7 +463,7 @@ As any other Python package, we can install from source code by just running: qiskit-aer$ pip install . This will build and install `Aer` with the default options which is probably suitable for most of the users. -There's another Pythonic approach to build and install software: build the wheels distributable file. +There's another Pythonic approach to building and installing software: build the wheels distributable file. qiskit-aer$ python ./setup.py bdist_wheel @@ -566,7 +566,7 @@ As any other Python package, we can install from source code by just running: (QiskitDevEnv) qiskit-aer > pip install . This will build and install `Aer` with the default options which is probably suitable for most of the users. -There's another Pythonic approach to build and install software: build the wheels distributable file. +There's another Pythonic approach to building and installing software: build the wheels distributable file. (QiskitDevEnv) qiskit-aer > python ./setup.py bdist_wheel diff --git a/README.md b/README.md index 199654cfce..d261484abc 100755 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ **Qiskit** is an open-source framework for working with noisy quantum computers at the level of pulses, circuits, and algorithms. -Qiskit is made up of elements that each work together to enable quantum computing. This element is **Aer**, which provides high-performance quantum computing simulators with realistic noise models. +Qiskit is made up of elements that work together to enable quantum computing. This element is **Aer**, which provides high-performance quantum computing simulators with realistic noise models. ## Installation @@ -14,7 +14,7 @@ We encourage installing Qiskit via the pip tool (a python package manager). The pip install qiskit qiskit-aer ``` -Pip will handle all dependencies automatically for us and you will always install the latest (and well-tested) version. +Pip will handle all dependencies automatically for us, and you will always install the latest (and well-tested) version. To install from source, follow the instructions in the [contribution guidelines](CONTRIBUTING.md). @@ -34,7 +34,7 @@ the same functionality found in the canonical `qiskit-aer` package, plus the ability to run the GPU supported simulators: statevector, density matrix, and unitary. **Note**: This package is only available on x86_64 Linux. For other platforms -that have CUDA support you will have to build from source. You can refer to +that have CUDA support, you will have to build from source. You can refer to the [contributing guide](CONTRIBUTING.md#building-with-gpu-support) for instructions on doing this. @@ -84,9 +84,9 @@ print('Counts(noise):', counts_noise) ## Contribution Guidelines If you'd like to contribute to Qiskit, please take a look at our -[contribution guidelines](CONTRIBUTING.md). This project adheres to Qiskit's [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expect to uphold to this code. +[contribution guidelines](CONTRIBUTING.md). This project adheres to Qiskit's [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. -We use [GitHub issues](https://github.com/Qiskit/qiskit-aer/issues) for tracking requests and bugs. Please use our [slack](https://qiskit.slack.com) for discussion and simple questions. To join our Slack community use the [link](https://qiskit.slack.com/join/shared_invite/zt-fybmq791-hYRopcSH6YetxycNPXgv~A#/). For questions that are more suited for a forum we use the Qiskit tag in the [Stack Exchange](https://quantumcomputing.stackexchange.com/questions/tagged/qiskit). +We use [GitHub issues](https://github.com/Qiskit/qiskit-aer/issues) for tracking requests and bugs. Please use our [slack](https://qiskit.slack.com) for discussion and simple questions. To join our Slack community use the [link](https://qiskit.slack.com/join/shared_invite/zt-fybmq791-hYRopcSH6YetxycNPXgv~A#/). For questions that are more suited for a forum, we use the Qiskit tag in the [Stack Exchange](https://quantumcomputing.stackexchange.com/questions/tagged/qiskit). ## Next Steps diff --git a/qiskit_aer/quantum_info/states/aer_densitymatrix.py b/qiskit_aer/quantum_info/states/aer_densitymatrix.py index 6bc4ce45c4..f9c5090562 100644 --- a/qiskit_aer/quantum_info/states/aer_densitymatrix.py +++ b/qiskit_aer/quantum_info/states/aer_densitymatrix.py @@ -40,7 +40,7 @@ def __init__(self, data, dims=None, **configs): AerDensityMatrix or QuantumCircuit or qiskit.circuit.Instruction): Data from which the densitymatrix can be constructed. This can be either a complex vector, another densitymatrix or statevector or a ``QuantumCircuit`` or - ``Instruction`` (``Operator`` is not supportted in the current implementation). + ``Instruction`` (``Operator`` is not supported in the current implementation). If the data is a circuit or instruction, the densitymatrix is constructed by assuming that all qubits are initialized to the zero state. dims (int or tuple or list): Optional. The subsystem dimension of diff --git a/qiskit_aer/quantum_info/states/aer_statevector.py b/qiskit_aer/quantum_info/states/aer_statevector.py index f5b91d322d..b243dd2d4f 100644 --- a/qiskit_aer/quantum_info/states/aer_statevector.py +++ b/qiskit_aer/quantum_info/states/aer_statevector.py @@ -40,7 +40,7 @@ def __init__(self, data, dims=None, **configs): qiskit.circuit.Instruction): Data from which the statevector can be constructed. This can be either a complex vector, another statevector or a ``QuantumCircuit`` or ``Instruction`` - (``Operator`` is not supportted in the current implementation). If the data is + (``Operator`` is not supported in the current implementation). If the data is a circuit or instruction, the statevector is constructed by assuming that all qubits are initialized to the zero state. dims (int or tuple or list): Optional. The subsystem dimension of