-
Notifications
You must be signed in to change notification settings - Fork 2.3k
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
Improve ZZFeatureMap API docs #12431
Comments
It looks like the docs have not been updated in 4 years, and the doc strings are not evaluated to find broken code. |
Hi! @nonhermitian |
Hi @Eric-Arellano, I have a doubt.
Output with
Output with
When I went to make changes here, I noticed that the line has already been updated, but is not reflecting in the documentation. |
Hey @Shivansh20128 , the difference is the dev version of the docs (corresponding to the You'll want to improve the dev version of the docs. So, yes, you'll be changing |
okay, I got it. Thank you Also, is there a way to see a preview of the documentation I am making (like how it would look on the website)? Because the changes I am making are in a .py and not a .md file, I cannot see if it looks the way I want it to. Thank you |
@Eric-Arellano I have created a pull request link with the required documentation for issue. I think there is some problem as my first PR has not been reviewed and merged yet. It is also based on documentation. |
Merging to I deployed your change this morning so it is now live.
You can run This preview is of Sphinx's output. To preview the actual website, you can follow this guide https://github.com/Qiskit/documentation#api-docs-authors-how-to-preview-your-changes. However, you almost never need to do that and that is much slower and more complex to do. Most people only do
There is no issue. In open source, it is normal to take some time for people to review because there are not enough maintainers to keep up with everything promptly. Please be patient.
That shouldn't matter. It's common for people to keep forks around, and it can be useful to show that you're engaged in open source.
No need to explicitly ask for the review. Jake is already auto-added to the review as part of terra-core. He's quite busy and will get to it when he has time. |
Some comments and questions:
|
Hi @Cryoris , Also, I did not understand what you meant by the first comment. Which docstring code examples are you talking about? |
@Eric-Arellano Thank you so much for the valuable information. I will keep this in mind. I am learning a lot from you guys. I couldn't be more grateful! |
I have created a new PR (and closed the previous one) that contains changes related to only this issue. I apologize for the inconvenience caused. |
You can see in Qiskit/documentation#2071 that #13231 indeed fixed the problems in the original post 🚀 Thank you @Shivansh20128 for making Qiskit better for everyone! |
Feedback from Paul Nation:
Also the
data
,entanglement_blocks
,num_parameters
, andparameters
properties have no docstring or type hints:The text was updated successfully, but these errors were encountered: