Qiskit
Fix how we pluralize objects like `MyClass`s
We frequently use the style "MyClasss" to refer to multiple objects belong to MyClass. It is much more clear to instead say ~"MyClass objects"~ "MyClass instances". That's better for translation, too.
You can use rg "\s\b"` to find instances of this.
- [ ] fix
guides/ - [ ] fix
tutorials/ - [ ] fix
learning/ - [ ] fix
qiskit-ibm-runtime(only dev docs) - [ ] fix
qiskit(only dev docs)
Hey @Osalotioman, that would be great! Some notes:
- This could potentially be time-consuming. So, feel free to split it up into multiple pull requests if you don't have time to do it all at once. For example, even if you only have time to fix 25%, that is better than 0%.
- API docs should not be updated directly in qiskit/documentation because they are generated. Instead, they would be updated in https://github.com/qiskit/qiskit and https://github.com/qiskit/qiskit-ibm-runtime, as they use Sphinx to generate their docs.
Thank you for offering to help and please let us know if you have any questions etc.
Thank you! That clarifies things. I’ll start with a manageable portion and submit it as separate PRs. I’ll make sure to update the API docs in the appropriate repos. I’ll reach out if anything comes up.
Thanks @Osalotioman! The remaining changes would be in this repository by changing the .mdx and .ipynb files directly. Per Jake's feedback, we should use "objects" rather than "instances" -- no need to change existing words. We only are trying to fix the 's pattern.