Skip to content

DOC102 false positives #20923

@ntBre

Description

@ntBre

There were two remaining false positives found in the ecosystem check on #20376.

  • disnake/client.py:814:9: DOC102 Documented parameter Example is not in the function's signature
    We look for a section called Examples, but I think it would be worth allowing singular Example too. I think this one is not specific to DOC102 and can affect other rules.
  • superset/async_events/api.py:57:11: DOC102 Documented parameter responses is not in the function's signature
    This and several other superset errors are from docstrings like
            """
          Read off of the Redis async events stream, using the user's JWT token and
          optional query params for last event received.
          ---
          get:
            summary: Read off of the Redis events stream
            description: >-
              Reads off of the Redis events stream, using the user's JWT token and
              optional query params for last event received.
            parameters:
            - in: query
              name: last_id
              description: Last ID received by the client
              schema:
                  type: string
            responses:
              200:
    which I guess looks like YAML. I feel like we could do something like not process sub-sections under an unknown heading to filter this out, but I haven't taken a closer look.

Metadata

Metadata

Assignees

No one assigned

    Labels

    ruleImplementing or modifying a lint rule

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions