diff options
| author | Markus Heiser <markus.heiser@darmarIT.de> | 2026-05-25 12:41:31 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-05-25 12:41:31 +0200 |
| commit | efc305b7f98399da2acc8596a496ad408c704d7b (patch) | |
| tree | 920d214f231f051f0e68b8c712f2dfe2f5ce993b /docs/dev/engines | |
| parent | 323ce7600444e98c1adcd4f0a9c109e9495a7748 (diff) | |
[mod] normalize variable name for the max number of results per request (#6131)
[mod] normalize variable name for the max number of results per request
In the past, we have used different names for the variable that specifies the
maximum number of hits in the outgoing request.
- ``page_size``
- ``number_of_results``
- ``nb_per_page``
Since *page_size* is the most accurate term and is also used in the XPath
engines, all other engines are adjusted accordingly within this
patch .. documentation adjusted accordingly.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/dev/engines')
| -rw-r--r-- | docs/dev/engines/engine_overview.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/dev/engines/engine_overview.rst b/docs/dev/engines/engine_overview.rst index 5c2773655..8df18e08c 100644 --- a/docs/dev/engines/engine_overview.rst +++ b/docs/dev/engines/engine_overview.rst @@ -107,7 +107,7 @@ module: ======================= =========== =========================================== base_url string base-url, can be overwritten to use same engine on other URL - number_of_results int maximum number of results per request + page_size int maximum number of results per request language string ISO code of language and country like en_US api_key string api-key if required by engine ======================= =========== =========================================== |