Absence of “Defaults to xx.” when the parameter has a default value

[aust-1]

When a parameter has a default value in Google style, we must specify “Defaults to xxx.” But if we don't specify it, pydoclint doesn't report anything.

For example, for this code, pydoclint doesn't report any problems:

  def safe_digital_read(self, n: int = 5) -> bool:
          """Read the digital value multiple times and return the majority value.
  
          Args:
              n (int, optional): Number of reads to perform.
  
          Returns:
              bool: The majority value read from the pin.
          """
          ...

whereas it should be:

  def safe_digital_read(self, n: int = 5) -> bool:
          """Read the digital value multiple times and return the majority value.
  
          Args:
              n (int, optional): Number of reads to perform. Defaults to 5.
  
          Returns:
              bool: The majority value read from the pin.
          """
          ...

[jsh9]

Hi @aust-1 , please refer to #179 for reasons not to implement this feature.

For the record, I'm not against this feature, I'm just not sure what style to enforce. Is Default to 5 or (Default to 5) or Default = 5?

Picking one style would inevitably make some other people unhappy.