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

Some typos in qiskit_aer.AerSimulator docs #1611

Closed
1ucian0 opened this issue Oct 4, 2022 · 13 comments · May be fixed by #1836 or #1838
Closed

Some typos in qiskit_aer.AerSimulator docs #1611

1ucian0 opened this issue Oct 4, 2022 · 13 comments · May be fixed by #1836 or #1838
Assignees
Labels
documentation Something is not clear or error in description good first issue Good for newcomers

Comments

@1ucian0
Copy link
Member

1ucian0 commented Oct 4, 2022

In https://qiskit.org/documentation/stubs/qiskit_aer.AerSimulator.html, there is a wild ~:
Screenshot 2022-10-04 at 13 49 10

And a missing <p>:
Screenshot 2022-10-04 at 13 49 36

@1ucian0 1ucian0 added the documentation Something is not clear or error in description label Oct 4, 2022
@1ucian0
Copy link
Member Author

1ucian0 commented Oct 4, 2022

There are also some missing options, like accept_distributed_results. Probably worth checking if all the options in all the methods are there

for i in AerSimulator().available_methods():
    print(AerSimulator(method=i).options)

@1ucian0 1ucian0 closed this as completed Oct 4, 2022
@1ucian0 1ucian0 reopened this Oct 4, 2022
@1ucian0 1ucian0 added the good first issue Good for newcomers label Oct 4, 2022
@2003jblake
Copy link

2003jblake commented Jan 19, 2023

Can I be assigned this please?
Ive sorted the rogue ~
I found a missing fullstop

Im not finding where the missing < p > belongs, I see no reason there isnt a break when compared to the other parts of the code

Is there anyone that can help me find the definitions of the missing methods and help me idenify which need definitions, as I see mps_omp_threads does not have documentation but is in the method list. No worries if I do not know enough and cant assign or help me

@hhorii
Copy link
Collaborator

hhorii commented May 10, 2023

@2003jblake We are always welcome for anyone to send PRs.

@devilkiller-ag
Copy link

Can I work on this issue?

@TerraVenil
Copy link
Contributor

TerraVenil commented May 28, 2023

Hi, @1ucian0. According to #380 class SnapshotProbabilities is not relevant anymore after 0.11 release. Therefore, probably one of the option can be remove reference to this type from documentation at all or replace it to a new type such that https://github.com/Qiskit/qiskit-aer/blob/main/src/simulators/stabilizer/stabilizer_state.hpp#L50 (usage https://github.com/Qiskit/qiskit-aer/blob/main/src/simulators/stabilizer/stabilizer_state.hpp#L227).
Also I found a similar reference to SnapshotProbabilities here https://qiskit.org/ecosystem/aer/stubs/qiskit_aer.QasmSimulator.html.

What option do we prefer more?

@TerraVenil
Copy link
Contributor

Regarding the issue

And a missing <p>:
image

The reason in CSS styles from qiskit_sphinx_theme https://github.com/Qiskit/qiskit_sphinx_theme/blob/1.10/qiskit_sphinx_theme/static/css/theme.css#L10595. The best option just to wait until new version of qiskit_sphinx_theme will me merged to main branch by this PR #1822 which should fix current issue automatically see https://github.com/Qiskit/qiskit_sphinx_theme/blob/1.12/qiskit_sphinx_theme/pytorch_base/static/css/theme.css#L10596.

Madhurima176 added a commit to Madhurima176/qiskit-aer that referenced this issue Jun 2, 2023
Added full stop to the end of the line 305.
Fixes Qiskit#1611
rahulsust added a commit to rahulsust/qiskit-aer that referenced this issue Jun 3, 2023
Summary
fixes Qiskit#1611
removed some typos and grammatical inconsistencies from the docs.
@natestemen
Copy link

@hhorii it looks like a PR has been accepted here, but it's not clear who should be awarded the bounty. Is this issue now complete?

Also, remember to assign the hackers who should receive the bounty to the issue so they can be awarded properly!

@TerraVenil
Copy link
Contributor

TerraVenil commented Jun 13, 2023

@1ucian0 or @hhorii, can you assign current issue to me? Thanks.

@hhorii
Copy link
Collaborator

hhorii commented Jun 14, 2023

Hmmm, maybe due to configuration of this repository or organization, I cannot assign contributors to this issue. I would like to assign @Innanov and @TerraVenil to this.

@natestemen
Copy link

@hhorii it looks like @1ucian0 was able to assign the hacker in #1632, so maybe he has admin privileges which allow him to do this?

@1ucian0
Copy link
Member Author

1ucian0 commented Jun 14, 2023

hi @Innanov, can you comment on this issue so I can assign you?

@Innanov
Copy link
Contributor

Innanov commented Jun 14, 2023

yes, please, thank you

@natestemen
Copy link

Should this issue be closed now? Our system does not recognize the bounty as complete since the issue is still open.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment