From 4a59b9283617e4e0f0e9385c4c7d062fb99fdbbb Mon Sep 17 00:00:00 2001 From: Matt Davis Date: Fri, 25 Aug 2023 05:03:50 -0400 Subject: [PATCH] restore docstring --- pipenv/utils/fileutils.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/pipenv/utils/fileutils.py b/pipenv/utils/fileutils.py index 8887c81b..728e174a 100644 --- a/pipenv/utils/fileutils.py +++ b/pipenv/utils/fileutils.py @@ -117,7 +117,12 @@ def path_to_url(path): def open_file(link, session: Optional[Session] = None, stream: bool = True): """Open local or remote file for reading. - Other details... + :param pipenv.patched.pip._internal.index.Link link: A link object from resolving dependencies with + pip, or else a URL. + :param Optional[Session] session: A :class:`~requests.Session` instance + :param bool stream: Whether to stream the content if remote, default True + :raises ValueError: If link points to a local directory. + :return: a context manager to the opened file-like object """ if not isinstance(link, str): try: