Skip to content

Docstring for pathlib.Path.walk isn't very helpful #142290

@lheckemann

Description

@lheckemann

Documentation

Currently, the docstring for pathlib.Path.walk doesn't actually describe the functionality itself, merely referring to os.walk. This makes using it a bit less convenient, since one can't work out from the docstring alone how to use it. The docstring should describe the triples that the function yields, and maybe os.walk's docstring should refer to pathlib.Path.walk as well in order to encourage use of the new interface.

Linked PRs

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dir

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions