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.

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

Add description of functools.partial in Executors documentation #2360

Open
jordandsullivan opened this issue May 9, 2024 Discussed in #2326 · 0 comments
Open

Add description of functools.partial in Executors documentation #2360

jordandsullivan opened this issue May 9, 2024 Discussed in #2326 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation executors

Comments

@jordandsullivan
Copy link
Contributor

Discussed in #2326

Originally posted by jordandsullivan April 25, 2024
In a fair number of example notebooks and tests, the utility functools.partial is used to creator an executor function with fewer arguments specific arguments set to particular values. e.g. https://github.com/unitaryfund/mitiq/blob/main/docs/source/examples/ddd_tutorial.md?plain=1#L182.

Given how common a use case this is (i.e. specifying kwargs for an executor but still running it as a function), I suggest we add a short description and example of this in our Executors documentation page.

@jordandsullivan jordandsullivan added documentation Improvements or additions to documentation executors labels May 9, 2024
@jordandsullivan jordandsullivan self-assigned this May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation executors
Projects
None yet
Development

No branches or pull requests

1 participant