Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-12926

Clarify return value documentation for Python

    XMLWordPrintable

    Details

      Description

      The guidelines for documenting return values in Python say to document them as if they were parameters, and gives an example of a tuple or object with x and y values.

      The current instructions are somewhat confusing, however, because return values do not have names: the example could just as well be interpreted as a description of object fields in the return value (e.g., myFunc().x or myFunc().y).

      It would be helpful if the guidelines could clarify that the docstring should choose a descriptive label rather than documenting something that exists in code, and if necessary provide some guidelines for the choice.

        Attachments

          Issue Links

            Activity

            There are no comments yet on this issue.

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              krzys Krzysztof Findeisen
              Watchers:
              Krzysztof Findeisen
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:

                  Jenkins

                  No builds found.