search

Qiskit / qiskit

Qiskit is an open-source SDK for working with quantum computers at the level of extended quantum circuits, operators, and primitives.
https://www.ibm.com/quantum/qiskit
Apache License 2.0
5k stars 2.32k forks source link

Spellcheck API docs (Unity Fund Hackathon) #12067

Closed Eric-Arellano closed 2 months ago

Eric-Arellano commented 5 months ago

This is part of https://github.com/Qiskit/documentation/issues/818. We still have to decide in that ticket what we long-term with spellchecking the API docs in qiskit/qiskit. In the meantime, it is valuable to fix all current spelling violations.

To do this:

  1. Clone https://github.com/Qiskit/documentation
  2. Edit the cspell config at https://github.com/Qiskit/documentation/blob/b7737fb4f8e7c0483a8e0af0ed62c59c828720c9/cspell/cSpell.json#L51 to not ignore /api/qiskit/dev, but we still want to ignore the other api/qiskit folders like /api/qiskit/0.*/*.mdx and /api/qiskit/*.mdx (current docs)
  3. Run cspell with the instructions at https://github.com/Qiskit/documentation#spellcheck
  4. Fix the spelling violations in a PR in this repository. It's plausible there will be legit words/phrases that are not issues. Those should instead be added to the dictionaries in qiskit/documentation as valid words (see the section "Fixing false positives")

It's best to keep these changes in one PR, rather than opening up a bunch of tiny PRs.

Raghav-Bell commented 5 months ago

I would like to work on this issue. Kindly please assign this issue to me. Thanks

1ucian0 commented 5 months ago

hi @Raghav-Bell , we are setting some issues (like this one) for coming events. Let's hold it for now :)

CRTejaswi commented 3 months ago

Hi, @Eric-Arellano @1ucian0 ! I'd like to work on this issue as a part of unitaryhack.

1ucian0 commented 3 months ago

sure thing @CRTejaswi ! Because the nature of the event, go ahead and PR it. The first/best PR can get the bounty (or could be shared if they complement).

CRTejaswi commented 3 months ago

sure thing @CRTejaswi ! Because the nature of the event, go ahead and PR it. The first/best PR can get the bounty (or could be shared if they complement).

Are EN-UK words to be treated as spelling mistakes (hence corrected)? eg. organised, behaviour (vs organized, behavior in EN-US)

Eric-Arellano commented 3 months ago

Are EN-UK words to be treated as spelling mistakes (hence corrected)?

Yes, please. We use EN-US for consistency.

CRTejaswi commented 3 months ago

Minor Update: Of the 25k identified spelling issues (non-unique), I've added most false positives to respective dictionaries, and fixed common typos (eg. neighbour/visualisation/...) through simple scripting. I'm taking a few hours off to rest, and will finish & update you once my cspell output is error-free.

Eric-Arellano commented 3 months ago

Thanks, @CRTejaswi!

~Any other Unitary Fund Hackathon people interested in this issue, please wait to get started on this ticket until @CRTejaswi has had some more time to finish. We want to respect how much time they've already put into this ticket and avoid duplicate work.~ Update: I misunderstood how the hackathon is intended to work, and it's still fair game for others to contribute.

CRTejaswi commented 3 months ago

I apologise for the delay. I've been occupied with some work, so, couldn't finish up. Will do shortly.

Eric-Arellano commented 3 months ago

All good, @CRTejaswi. By the way, in case it wasn't already clear, the fixes will need to happen in this repo qiskit/qiskit, not qiskit/documentation. That's because the docs are generated from qiskit/qiskit, so it's the "source of truth".

1ucian0 commented 2 months ago

just few remainders to everyone:

ljcamargo commented 2 months ago

@1ucian0 ok then, here is the PR on Qiskit/qiskit https://github.com/Qiskit/qiskit/pull/12501

ljcamargo commented 2 months ago

hello @1ucian0 I guess the owner has to do some checks before the PR to be merged, but I guess my job is done. Let me know to consider this bounty is achieved, thanks!

1ucian0 commented 2 months ago

You need to address the comments and conflicts in the PR. The bounty will be assigned to you after that. The issue will be crossed out from the website once this issue is closed (because the PR was merged)

ljcamargo commented 2 months ago

hi @1ucian0 I resolved the conflict, I think there is no other comment for me, let me know is something else is missing