Changes between Version 1 and Version 2 of Ticket #7477, comment 58


Ignore:
Timestamp:
06/02/13 01:33:09 (8 years ago)
Author:
tscrim
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Ticket #7477, comment 58

    v1 v2  
    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:
     1My 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:
    22{{{
    33def loops(self):