Skip to content

Commit

Permalink
feat(docs): document ASyncDescriptor behavior in dependant libs
Browse files Browse the repository at this point in the history
  • Loading branch information
BobTheBuidler committed Sep 6, 2024
1 parent dd3b0d4 commit 12d01be
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion a_sync/a_sync/_descriptor.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,11 @@ def __init__(
"""The name of the field this descriptor is bound to."""

functools.update_wrapper(self, self.__wrapped__)

if self.__doc__ is None:
self.__doc__ = "Since {self.__name__} is a {self.__docstring_append__}"
else:
self.__doc__ += "\n\nSince {self.__name__} is a {self.__docstring_append__}"

def __repr__(self) -> str:
return f"<{self.__class__.__name__} for {self.__wrapped__}>"

Expand Down

0 comments on commit 12d01be

Please sign in to comment.