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

algo parameter documentation #122

Open
timosachsenberg opened this issue Sep 20, 2021 · 2 comments
Open

algo parameter documentation #122

timosachsenberg opened this issue Sep 20, 2021 · 2 comments
Assignees

Comments

@timosachsenberg
Copy link
Contributor

timosachsenberg commented Sep 20, 2021

add to https://pyopenms.readthedocs.io/en/latest/parameter_handling.html
how to getDescription in a nice way

@timosachsenberg
Copy link
Contributor Author

timosachsenberg commented Sep 20, 2021

also check if it makes sense to print key, value, description in

 __repr__ or  __str__

e.g., users want to write print(myParam)

def __str__(self):
  return list(zip(p.keys(), p.values(), p.descriptions()))

needs implementation of def descriptions:

@tapaswenipathak tapaswenipathak self-assigned this May 30, 2022
@timosachsenberg
Copy link
Contributor Author

probably needs more thinking

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants