qiskit-aer icon indicating copy to clipboard operation
qiskit-aer copied to clipboard

Some typos in qiskit_aer.AerSimulator docs

Open 1ucian0 opened this issue 2 years ago • 1 comments

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 avatar Oct 04 '22 11:10 1ucian0

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 avatar Oct 04 '22 11:10 1ucian0

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

2003jblake avatar Jan 19 '23 23:01 2003jblake

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

hhorii avatar May 10 '23 06:05 hhorii

Can I work on this issue?

devilkiller-ag avatar May 26 '23 10:05 devilkiller-ag

Hi, @1ucian0. According to https://github.com/Qiskit/qiskit-aer/pull/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 avatar May 28 '23 15:05 TerraVenil

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 https://github.com/Qiskit/qiskit-aer/pull/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.

TerraVenil avatar May 28 '23 16:05 TerraVenil

@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!

natestemen avatar Jun 08 '23 22:06 natestemen

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

TerraVenil avatar Jun 13 '23 17:06 TerraVenil

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.

hhorii avatar Jun 14 '23 03:06 hhorii

@hhorii it looks like @1ucian0 was able to assign the hacker in https://github.com/Qiskit/qiskit-aer/issues/1632, so maybe he has admin privileges which allow him to do this?

natestemen avatar Jun 14 '23 04:06 natestemen

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

1ucian0 avatar Jun 14 '23 12:06 1ucian0

yes, please, thank you

Innanov avatar Jun 14 '23 13:06 Innanov

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

natestemen avatar Jun 14 '23 15:06 natestemen