Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Fix outdated system dependencies in README: remove Pillow build-time deps (bundled in wheels), add missing `libcairo` across all platforms (#152)
- Improve contribution setup instructions: use `hatch shell`, clarify commands must be run from local clone root (#153)
- Bring coverage back to 100% (#293)
- Fix `Creator.config_indexing` docstring to reflect that only the full-text index is toggled; title indexing is always performed by libzim (#294)

### Changed

Expand Down
7 changes: 5 additions & 2 deletions src/zimscraperlib/zim/creator.py
Original file line number Diff line number Diff line change
Expand Up @@ -127,9 +127,12 @@ def __init__(
def config_indexing(
self, indexing: bool, language: str | None = None # noqa: FBT001
):
"""Toggle full-text and title indexing of entries
"""Toggle full-text indexing of entries

Uses Language metadata's value (or "") if not set"""
Uses Language metadata's value (or "") if not set.

Note: title indexing is always performed by libzim and cannot be
disabled via this method; only the full-text index is toggled."""
language = language or self._get_first_language_metadata_value() or ""
if indexing and not is_valid_iso_639_3(language):
raise ValueError("Not a valid ISO-639-3 language code")
Expand Down
Loading