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

Add multiline example to Struct

    Details

    • Type: Improvement
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: dm_dev_guide
    • Labels:
      None
    • Templates:
    • Story Points:
      2.4
    • Team:
      SQuaRE

      Description

      Per review discussion in DM-16017, the description of a `Struct`'s fields should be indented to the level of the field name. However, this is not clear from the example in the python style guide (where all the field descriptions fit on one line), nor from the rest of the guide (which uses different indentation styles in different contexts).

      Add a long description to the example so that the policy is clearly documented.

        Attachments

          Container Issues

            Issue Links

              Activity

                People

                • Assignee:
                  jsick Jonathan Sick
                  Reporter:
                  krzys Krzysztof Findeisen
                  Reviewers:
                  Kian-Tat Lim
                  Watchers:
                  Jonathan Sick, Kian-Tat Lim, Krzysztof Findeisen
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  3 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:

                    Summary Panel