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

Document all possible evalFuncs #206

Closed
ewu63 opened this issue Mar 21, 2022 · 4 comments · Fixed by #240
Closed

Document all possible evalFuncs #206

ewu63 opened this issue Mar 21, 2022 · 4 comments · Fixed by #240
Assignees
Labels
documentation This is related to documentation

Comments

@ewu63
Copy link
Collaborator

ewu63 commented Mar 21, 2022

Description

We should document all the possible values to evalFuncs. This is currently stored in self.basicCostFunctions.

Potential solution

Maybe reuse the options table/list to document this? This feels like a rather general thing for solvers, e.g. what they can compute.

@ewu63 ewu63 added the documentation This is related to documentation label Mar 21, 2022
@gawng gawng self-assigned this Apr 22, 2022
@gawng
Copy link
Contributor

gawng commented Apr 22, 2022

@ArshSaja do you have a branch with this started? If you have a branch I can work off of, I won't start a new one. Please let me know either way, thanks.

@ArshSaja
Copy link
Contributor

ArshSaja commented May 4, 2022

@gang525 Now we can split the evalfunc option to finish the explanation. After cd0 @gang525 will take care of it

@ewu63
Copy link
Collaborator Author

ewu63 commented Oct 3, 2022

@ArshSaja @gang525 what's the status on this?

@gawng
Copy link
Contributor

gawng commented Oct 3, 2022

Yea, the status is ive been thinking about this but i just havent done it yet but i know this is time sensitive to before people leave like Eirikur, anil, you, yingqian etc who can review it. I have an abstract due mid october and trying to finalize my trip to australia but i can work on this after.

@gawng gawng mentioned this issue Oct 22, 2022
14 tasks
@ewu63 ewu63 linked a pull request Dec 14, 2022 that will close this issue
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is related to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants