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

Update docs URL #115

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update docs URL #115

wants to merge 3 commits into from

Conversation

josh146
Copy link
Member

@josh146 josh146 commented Aug 22, 2022

General guidelines

  • Do not make a pull request for minor typos/cosmetic code changes - make an issue instead.

Before submitting

Before submitting a pull request, please make sure the following is done:

  • All new features must include a unit test.
    If you've fixed a bug or added code that should be tested, add a test to the test directory!

  • All new functions and code must be clearly commented and documented.
    Have a look through the source code at some of the existing function docstrings - the easiest
    approach is to simply copy an existing docstring and modify it as appropriate.
    If you do make documentation changes, make sure that the docs build and render correctly by running make docs.

  • Ensure that the test suite passes, by running make test.

  • Make sure the modified code in the pull request conforms to the PEP8 coding standard.
    The PennyLane source code conforms to PEP8 standards (https://www.python.org/dev/peps/pep-0008/).
    We check all of our code against Pylint (https://www.pylint.org/). To lint modified files, simply
    pip install pylint, and then from the source code directory, run pylint pennylane/path/to/file.py.

Pull request template

When ready to submit, delete everything above the dashed line and fill in the pull request template.

Please include as much detail as possible regarding the changes made/new features
added/performance improvements. If including any bug fixes, mention the issue numbers associated with the bugs.


Description of the Change:

Benefits:

Possible Drawbacks:

Related GitHub Issues:

@codecov
Copy link

codecov bot commented Aug 22, 2022

Codecov Report

Merging #115 (5f66136) into master (700ac63) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##            master      #115   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          498       498           
=========================================
  Hits           498       498           

@trbromley
Copy link
Contributor

@albi3ro, we can also merge in this PR 👍

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