Skip to content

Commit

Permalink
Fix a few typos (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
pitmonticone authored Nov 16, 2022
1 parent 0446882 commit 9ef3d14
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 18 deletions.
34 changes: 18 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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")'`

Expand Down
2 changes: 1 addition & 1 deletion PyBraket/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down

4 comments on commit 9ef3d14

@kshyatt-aws
Copy link
Contributor

Choose a reason for hiding this comment

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

@JuliaRegistrator register() subdir=PyBraket

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request created: JuliaRegistries/General/72482

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a PyBraket-v0.1.0 -m "<description of version>" 9ef3d14c93f7cfead9ecd1d55ada99618be17682
git push origin PyBraket-v0.1.0

@kshyatt-aws
Copy link
Contributor

Choose a reason for hiding this comment

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

@JuliaRegistrator register() subdir=PyBraket

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request updated: JuliaRegistries/General/72482

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a PyBraket-v0.1.0 -m "<description of version>" 9ef3d14c93f7cfead9ecd1d55ada99618be17682
git push origin PyBraket-v0.1.0

Please sign in to comment.