Skip to content

fix: python function definition helper texts of directory qiskit/algorithms/optimizers/#11080

Merged
ElePT merged 1 commit into
Qiskit:mainfrom
shresthasurav:patch1
Oct 23, 2023
Merged

fix: python function definition helper texts of directory qiskit/algorithms/optimizers/#11080
ElePT merged 1 commit into
Qiskit:mainfrom
shresthasurav:patch1

Conversation

@shresthasurav
Copy link
Copy Markdown
Contributor

Summary

This pull request fixes typos in function helper documentation text in python files of the directory qiskit/algorithms/optimizers/gradient_descent.py

Details and comments

Following are the typos fixed in this pull request:

  1. lenght -> length
  2. accomodate -> accommodate
  3. ammount -> amount
  4. supress -> suppress
  5. directon -> direction
  6. optmization -> optimization
  7. funtion -> function
  8. paremeters -> parameters

@shresthasurav shresthasurav requested review from a team, ElePT and woodsp-ibm as code owners October 22, 2023 09:29
@qiskit-bot qiskit-bot added the Community PR PRs from contributors that are not 'members' of the Qiskit repo label Oct 22, 2023
@qiskit-bot
Copy link
Copy Markdown
Collaborator

Thank you for opening a new pull request.

Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient.

While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone.

One or more of the the following people are requested to review this:

  • @ElePT
  • @Qiskit/terra-core
  • @woodsp-ibm

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Oct 22, 2023

CLA assistant check
All committers have signed the CLA.

@shresthasurav shresthasurav changed the title fix: typos in python files of directory qiskit/algorithms/optimizers/ fix: python function definition helper texts of directory qiskit/algorithms/optimizers/ Oct 22, 2023
@woodsp-ibm woodsp-ibm added documentation Something is not clear or an error documentation stable backport potential Make Mergify open a backport PR to the most recent stable branch on merge. mod: algorithms labels Oct 22, 2023
@woodsp-ibm
Copy link
Copy Markdown
Member

Thanks for the corrections - it looks fine to me. I will note that the whole of qiskit.algorithms is deprecated and soon to be removed (after the imminent release) #10991. Since this will still exist in the docs for this upcoming version, and that already has its own branch as a release candidate, I marked this to be backported so it can go with that when its published. The algorithms now exist in separate repo https://github.com/qiskit-community/qiskit-algorithms but I will note that a spell checker was enabled there and at a quick glance the above fixes have been taken care of there due to them being picked up by the spell checker after the code was migrated there.

@woodsp-ibm woodsp-ibm added this to the 0.45.0 milestone Oct 22, 2023
Copy link
Copy Markdown
Contributor

@ElePT ElePT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM to merge/backport this fix, but as @woodsp-ibm mentioned, please remember for future contributions that qiskit.algorithms is deprecated and soon to be removed from qiskit, as it has been migrated to a separate repo: https://github.com/qiskit-community/qiskit-algorithms.

@ElePT ElePT added this pull request to the merge queue Oct 23, 2023
@shresthasurav
Copy link
Copy Markdown
Contributor Author

LGTM to merge/backport this fix, but as @woodsp-ibm mentioned, please remember for future contributions that qiskit.algorithms is deprecated and soon to be removed from qiskit, as it has been migrated to a separate repo: https://github.com/qiskit-community/qiskit-algorithms.

I'll keep that in mind. Thanks! ❤️

Merged via the queue into Qiskit:main with commit 2c01ff8 Oct 23, 2023
mergify Bot pushed a commit that referenced this pull request Oct 23, 2023
github-merge-queue Bot pushed a commit that referenced this pull request Oct 23, 2023
…#11080) (#11081)

(cherry picked from commit 2c01ff8)

Co-authored-by: Surav Shrestha <148626286+shresthasurav@users.noreply.github.com>
@ElePT ElePT added the Changelog: None Do not include in the GitHub Release changelog. label Nov 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Changelog: None Do not include in the GitHub Release changelog. Community PR PRs from contributors that are not 'members' of the Qiskit repo documentation Something is not clear or an error documentation stable backport potential Make Mergify open a backport PR to the most recent stable branch on merge.

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

5 participants