Skip to content

Commit a87fa17

Browse files
committed
Added description to DocDetails.file_location
1 parent 6b3de75 commit a87fa17

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

src/paperqa/types.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -664,7 +664,13 @@ class DocDetails(Doc):
664664
" hashing the DOI or a stringifying a UUID."
665665
),
666666
)
667-
file_location: str | os.PathLike | None = None
667+
file_location: str | os.PathLike | None = Field(
668+
default=None,
669+
description=(
670+
"Optional path to the stored paper, if stored locally"
671+
" or in a mountable location such as a cloud bucket."
672+
),
673+
)
668674
license: str | None = Field(
669675
default=None,
670676
description=(

0 commit comments

Comments
 (0)