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

Redesign docs #60

Merged
merged 9 commits into from Apr 14, 2020
Merged

Redesign docs #60

merged 9 commits into from Apr 14, 2020

Conversation

mariaschuld
Copy link
Contributor

Description of the Change:

Redesign documentation of the plugin to be consistent with others.

Since this is a larger PR, it is recommended to check the docs in a local build.

The PR also includes a minor change in an import statement, to prevent automodapi from documenting imported classes.

@mariaschuld
Copy link
Contributor Author

mariaschuld commented Apr 13, 2020

The tests are failing on master as well. I added a ticket on that.

I think it is a change in the IBM API? The fails complain about the user keyword argument...

@mariaschuld mariaschuld requested a review from thisac April 14, 2020 07:41
Copy link

@thisac thisac left a comment

Choose a reason for hiding this comment

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

Great job! I had some minor comments here as well. I also noticed the line This plugin requires Python version 3.5 and above..., which probably should be This plugin requires Python version 3.5 or above... (with an or instead of and), but I couldn't comment that line, since it wasn't really part of this PR. It's on line line 61 in README.rst. 🙂

README.rst Outdated Show resolved Hide resolved
doc/devices/ibm.rst Outdated Show resolved Hide resolved
pennylane_pq/ops.py Outdated Show resolved Hide resolved
@thisac
Copy link

thisac commented Apr 14, 2020

The tests are failing on master as well. I added a ticket on that.

I think it is a change in the IBM API? The fails complain about the user keyword argument...

I noticed that as well. I agree it seems like it could be caused by a change in the IBM API, but I'm not at all familiar with it. I could look into it a bit later, but maybe there's someone else who is more familiar with the API and could solve it quicker. 🙂

@josh146
Copy link
Member

josh146 commented Apr 14, 2020

A couple of months ago, IBM deprecated their original v1 API, for a new v2 API.

  • Has ProjectQ been updated to take this into account? v0.5.0 of ProjectQ was released last month.

  • If so, is this a change we can make in the plugin?

mariaschuld and others added 3 commits April 14, 2020 17:26
Co-Authored-By: Theodor <theodor@xanadu.ai>
Co-Authored-By: Theodor <theodor@xanadu.ai>
Co-Authored-By: Theodor <theodor@xanadu.ai>
@mariaschuld
Copy link
Contributor Author

We decided that I will open an issue, but we wait for further development from the ProjectQ side.

@mariaschuld
Copy link
Contributor Author

@josh146 can we merge this besides the failing tests?

@josh146
Copy link
Member

josh146 commented Apr 14, 2020

Go for it!

@josh146 josh146 merged commit 648f337 into master Apr 14, 2020
@josh146 josh146 deleted the redesign_docs branch April 15, 2020 03:22
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.

None yet

3 participants