Clearly state expected inputs / possible outputs in module manuals
#documentation #enhancement
It would be nice to clearly state for each module, what exact objects does it expect from the clipboard, how does it modify them and what does it write to the clipboard.
As APSQ does it for APSQ messages. It really improves manual readability in terms "How do I build a pipeline from separate modules".
Could be either
- a line in module's readme header
- or some arbitrary expression (probably this one is preferred as there could be different options and objects could be not required strictly)