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

Clarify formatting for parameters

    XMLWordPrintable

    Details

      Description

      The guidelines for documenting function parameters in Python give examples showing the parameter name, followed by a space, a colon, a space, and a text string describing the type. However, the guidelines do not say that this whitespace is significant: if the parameter name is immediately followed by a colon, the type description will be printed verbatim (with, for example, explicit ` marks).

      Please update the guide to specifically say that the parameter name and the colon must be separated by a space.

        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.