Uploaded image for project: 'Core Server'
  1. Core Server
  2. SERVER-35195

Remove Python linting rule requiring docstring for magic functions

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Trivial - P5
    • Resolution: Fixed
    • Affects Version/s: 4.0.0-rc0
    • Fix Version/s: 4.0.0-rc2, 4.1.1
    • Component/s: Testing Infrastructure
    • Labels:
      None
    • Backwards Compatibility:
      Fully Compatible
    • Backport Requested:
      v4.0, v3.6
    • Sprint:
      TIG 2018-06-04, TIG 2018-06-18
    • Story Points:
      1

      Description

      Add an exception for rule d105 in pydocstyles and remove redundant magic method docstrings.

      docstrings for magic functions don't provide much value. They're mostly useful for describing parameters, which is not checked by d105.

        Attachments

          Activity

            People

            Assignee:
            robert.guo Robert Guo
            Reporter:
            robert.guo Robert Guo
            Participants:
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: