Skip to content

Better descriptions and log messages #524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 3, 2024
Merged

Better descriptions and log messages #524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce6a73f
Cleaned up the descriptions a bit
jamesbraza Oct 3, 2024
a46f662
Added the index name to the warning log
jamesbraza Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion paperqa/agents/search.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,7 +511,8 @@ async def get_directory_index( # noqa: PLR0912
]
if len(valid_papers_rel_file_paths) > WARN_IF_INDEXING_MORE_THAN:
logger.warning(
f"Indexing {len(valid_papers_rel_file_paths)} files may take a few minutes."
f"Indexing {len(valid_papers_rel_file_paths)} files into the index"
f" {search_index.index_name}, may take a few minutes."
)

index_unique_file_paths: set[str] = set((await search_index.index_files).keys())
Expand Down
4 changes: 2 additions & 2 deletions paperqa/settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ class IndexSettings(BaseModel):
use_absolute_paper_directory: bool = Field(
default=False,
description=(
"Opt-in flag to convert the index_directory to an absolute path. Setting"
"Opt-in flag to convert the paper_directory to an absolute path. Setting"
" this to True will make the index user-specific, defeating sharing."
),
)
Expand Down Expand Up @@ -500,7 +500,7 @@ class Settings(BaseSettings):
)
index_absolute_directory: bool = Field(
default=False,
description="Whether to use the absolute directory for the PQA index",
description="Whether to use the absolute paper directory for the PQA index",
exclude=True,
frozen=True,
)
Expand Down