Noise calculation metadata should be part of noise class information
Just like suggested plotting style is part of noise classes, I feel there should be a way to add some text in each class definition which stays with the noise object wherever. This text would be a choice of coder which should include maybe paper details, main noise calculation expression, some elog post, comments, warnings etc. This way whenever someone is using these classes by importing them, they would have a way of reading about how the noise is calculated without going back to the code. I'm not sure though how exactly this can be implemented. I'm sure the overlords can improve this idea further.
Activity
@anchal.gupta Any reason why not just use the noise class docstring for this? That was my intention at least.
No other reason than me being unaware of the accessibility of docstrings. This makes sense now. But I think it is not a prevalent practice in our community to write more than noise name in the docstring of noise classes (eg. gwinc/ifo/noises.py).
Also, I still would have liked it if the docstring information is stored with traces dictionary returned by Budget.run(), or is it still accessible, only I don't know about it?
If an easy way exists to access docstring of noise calculation, maybe that should go in the repo README for newbies like me.
But I think it is not a prevalent practice in our community to write more than noise name in the docstring of noise classes
Making a new API method of adding strings won't solve this cultural problem. Having a enterprising implementer go through the code and set an strong example by adding them consistently to the existing code will. Granted, a means of reading them later should be made available.
If #59 (closed) is implemented then the return struct in the traces dictionary can have a docstr element, possibly after having gone through a call of budget.docstr.format(ifo = ifo) so that docstr can pull things out of the ifo class.
