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.

Sign up for GitHub

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

Jump to bottom

Docstring typo in GradientDescent #208

Closed
GuillermoAbadLopez opened this issue Oct 15, 2024 · 2 comments
Closed

Docstring typo in GradientDescent #208

GuillermoAbadLopez opened this issue Oct 15, 2024 · 2 comments
Labels
bug Something isn't working

Comments

@GuillermoAbadLopez
Copy link
Contributor

GuillermoAbadLopez commented Oct 15, 2024 •
edited
Loading

Enviorement

Not applicable / qiskit_algorithms documentation of version 0.3.0

What is happening?

The docstring of GradientDescent, has an example that doesn't work.

How can we reproduce the issue?

The docstring of GradientDescent defines a function f, and later uses a function fun instead:
Screenshot 2024-10-15 at 17 11 32

What should happen?

f and fun, should have the same name

Any suggestions?

I guess fun is a better one, since its not a single letter.
I'll open a PR changing it to fun(x)
@GuillermoAbadLopez GuillermoAbadLopez added the bug Something isn't working label Oct 15, 2024
@GuillermoAbadLopez GuillermoAbadLopez mentioned this issue Oct 15, 2024
Merged
@GuillermoAbadLopez
Copy link
Contributor Author

PR solving it: #209

@GuillermoAbadLopez GuillermoAbadLopez changed the title Docstring typo in GradientDescent Docstring typo in GradientDescent Oct 15, 2024
@GuillermoAbadLopez
Copy link
Contributor Author

Closing Issue, after PRs has been merged

Thanks @ElePT, very quick response! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@GuillermoAbadLopez