pyopenms-docs icon indicating copy to clipboard operation
pyopenms-docs copied to clipboard

algo parameter documentation

Open timosachsenberg opened this issue 3 years ago • 2 comments

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

timosachsenberg avatar Sep 20 '21 16:09 timosachsenberg

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:

timosachsenberg avatar Sep 20 '21 17:09 timosachsenberg

probably needs more thinking

timosachsenberg avatar Mar 29 '23 08:03 timosachsenberg