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

Remove Python linting rule requiring docstring for magic functions

    XMLWordPrintableJSON

Details

    • Fully Compatible
    • v4.0, v3.6
    • TIG 2018-06-04, TIG 2018-06-18
    • 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

            robert.guo@mongodb.com Robert Guo (Inactive)
            robert.guo@mongodb.com Robert Guo (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: