algolia / algolia/docsearch-scraper

Add check for "unknown" parameters in DocSearch config

Open
#326 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
322
Forks
115
PR merge metrics
No merged PRs in 30d

Description

I had a `min_indexed_lvl` parameter in a config, but the parameter is actually called `min_indexed_level`. But DocSearch scraper crawled the site as usual and I had no idea there is something wrong.

Is it possible to add a check which would raise a warning message when there are “unknown” parameters in the config?

Contributor guide

Open the contributing guide

Research direction

Start by locating the DocSearch scraper's configuration parsing and parameter definitions. Check how configuration keys are currently handled, then add coverage for an unknown key such as `min_indexed_lvl`; done means the scraper warns about unrecognized parameters while continuing to identify the correctly named configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.