Skip to content

Commit

Permalink
docs: fix get_members docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
Ravencentric committed Jul 29, 2024
1 parent 41f6f8b commit 3f5e3c9
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/archivefile/_core.py
Original file line number Diff line number Diff line change
Expand Up @@ -222,12 +222,12 @@ def get_member(self, member: StrPath) -> ArchiveMember:
@validate_call
def get_members(self) -> Generator[ArchiveMember]:
"""
Retrieve all members of the archive as a tuple of ArchiveMember objects.
Retrieve all members of the archive as a generator of `ArchiveMember` objects.
Yields
-------
Generator[ArchiveMember]
Members of the archive as a generator of ArchiveMember objects.
ArchiveMember
Each member of the archive as an `ArchiveMember` object.
Examples
--------
Expand Down

0 comments on commit 3f5e3c9

Please sign in to comment.