From 9ef3d14c93f7cfead9ecd1d55ada99618be17682 Mon Sep 17 00:00:00 2001 From: Pietro Monticone <38562595+pitmonticone@users.noreply.github.com> Date: Wed, 16 Nov 2022 21:36:35 +0100 Subject: [PATCH] Fix a few typos (#7) --- CONTRIBUTING.md | 34 ++++++++++++++++++---------------- PyBraket/README.md | 2 +- docs/src/index.md | 2 +- 3 files changed, 20 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ef6e59cb..7aea6e5b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,21 +8,23 @@ information to effectively respond to your bug report or contribution. ## Table of Contents -* [Report Bugs/Feature Requests](#report-bugsfeature-requests) -* [Contribute via Pull Requests (PRs)](#contribute-via-pull-requests-prs) - * [Pull Down the Code](#pull-down-the-code) - * [Run the Unit Tests](#run-the-unit-tests) - * [Run the Integration Tests](#run-the-integration-tests) - * [Make and Test Your Change](#make-and-test-your-change) - * [Commit Your Change](#commit-your-change) - * [Send a Pull Request](#send-a-pull-request) -* [Documentation Guidelines](#documentation-guidelines) - * [API References (docstrings)](#api-references-docstrings) - * [Build and Test Documentation](#build-and-test-documentation) -* [Find Contributions to Work On](#find-contributions-to-work-on) -* [Code of Conduct](#code-of-conduct) -* [Security Issue Notifications](#security-issue-notifications) -* [Licensing](#licensing) +- [Contributing Guidelines](#contributing-guidelines) + - [Table of Contents](#table-of-contents) + - [Report Bugs/Feature Requests](#report-bugsfeature-requests) + - [Contribute via Pull Requests (PRs)](#contribute-via-pull-requests-prs) + - [Pull Down the Code](#pull-down-the-code) + - [Run the Unit Tests](#run-the-unit-tests) + - [Run the Integration Tests](#run-the-integration-tests) + - [Make and Test Your Change](#make-and-test-your-change) + - [Commit Your Change](#commit-your-change) + - [Send a Pull Request](#send-a-pull-request) + - [Documentation Guidelines](#documentation-guidelines) + - [API References (docstrings)](#api-references-docstrings) + - [Build and Test Documentation](#build-and-test-documentation) + - [Find Contributions to Work On](#find-contributions-to-work-on) + - [Code of Conduct](#code-of-conduct) + - [Security Issue Notifications](#security-issue-notifications) + - [Licensing](#licensing) ## Report Bugs/Feature Requests @@ -58,7 +60,7 @@ Before sending us a pull request, please ensure that: ### Run the Unit Tests -You can run the package tests using Julia's built-in unit testing sytem. To run the Braket unit tests: +You can run the package tests using Julia's built-in unit testing system. To run the Braket unit tests: `julia -e 'using Pkg; Pkg.test("Braket")'` diff --git a/PyBraket/README.md b/PyBraket/README.md index 084877a6..89a2133f 100644 --- a/PyBraket/README.md +++ b/PyBraket/README.md @@ -2,7 +2,7 @@ **PyBraket.jl is not an officially supported AWS product.** -This package provides Julia-Python interopability between `Braket.jl` and Python features of the Amazon Braket SDK, such as the Amazon Braket [Local Simulators](https://docs.aws.amazon.com/braket/latest/developerguide/braket-send-to-local-simulator.html) and +This package provides Julia-Python interoperability between `Braket.jl` and Python features of the Amazon Braket SDK, such as the Amazon Braket [Local Simulators](https://docs.aws.amazon.com/braket/latest/developerguide/braket-send-to-local-simulator.html) and [Local Jobs](https://docs.aws.amazon.com/braket/latest/developerguide/braket-jobs-local-mode.html). This is *experimental* software, and support may be discontinued in the future. For a fully supported SDK, please use diff --git a/docs/src/index.md b/docs/src/index.md index 3e0db37c..a6ab5c25 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -25,7 +25,7 @@ No. `Braket.jl` is a "software development kit" (SDK) written in [Julia](https:/ In order to use most features of Amazon Braket, you will *not* need a Python installation or to install the Python SDK or any of its dependencies. There are some exceptions - if you want to run a [`LocalJob`](https://docs.aws.amazon.com/braket/latest/developerguide/braket-jobs-local-mode.html) or run a task on one of the [`Braket local simulators`](https://github.com/aws/amazon-braket-default-simulator-python) you will need to use the Python -interoperability package `PyBraket.jl`, which comes with `Braket.jl` as a sub-packge in the same repo. Refer to the `PyBraket.jl` `README` for more information. +interoperability package `PyBraket.jl`, which comes with `Braket.jl` as a sub-package in the same repo. Refer to the `PyBraket.jl` `README` for more information. If you want to run tasks or Amazon Braket Hybrid Jobs on AWS managed devices, you will need to have an AWS account and to [`onboard to Braket`](https://docs.aws.amazon.com/braket/latest/developerguide/braket-enable-overview.html).