| 1 | | My 2 cents on `OUTPUT:` and `INPUT:` blocks. iI there is no input other than ``self``, there is no need for an `INPUT:` IMO since with ``self``, the input is clear. For output blocks, if the short description of the method (i.e. the first line) tells the object that it returns, I don't see the need to write an `OUTPUT:` block. Additionally if the object needs description (mathematically), then I think that should go in the second paragraph of the documentation. For example: |
| | 1 | My 2 cents on `OUTPUT:` and `INPUT:` blocks. If there is no input other than `self`, there is no need for an `INPUT:` IMO since with `self`, the input is clear. For output blocks, if the short description of the method (i.e. the first line) tells the object that it returns, I don't see the need to write an `OUTPUT:` block. Additionally if the object needs description (mathematically), then I think that should go in the second paragraph of the documentation. For example: |
