Skip to content

Extract: docstrings lie #403

Description

@akx
  • messages.extract():
    • Docs say: This function returns tuples of the form (lineno, message, comments).
    • Yields 4-tuples (lineno, messages, comments, context)
  • messages.extract_from_file():
    • Docs say: This function returns a list of tuples of the form (lineno, funcname, message).
    • Returns a list of 4-tuples (lineno, messages, comments, context) (from extract)
  • messages.check_and_call_extract_file():
    • Does not document what it returns
    • Yields 5-tuples (filename, lineno, messages, comments, context)
  • messages.extract_from_dir():
    • Docs say: This function generates tuples of the form (filename, lineno, message, comments, context).
    • Actually does exactly that!

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions