This repository has been archived by the owner on Sep 7, 2023. It is now read-only.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
move meta information from comment to the about variable
so the preferences, the documentation can show these information
the different URL have been checked and updated (especially API documentation URL).
Also:
Why is this change important?
See #2442
Currently the engine list in
/prefereneces
or in the documentation show a list of name without a description or a link.This PR adds the required information to implement this feature, but I suggest to implement the UI in another PR.
Without this PR, the top head comment in an engine provides some information:
@website
: the user URL, exactly what would be nice to display to the user.@provide-api
: does the actual engine provide an official API ? usually the source code include an URL.@using-api
: does searx use this API ?@results
: what kind of data searx deal with ? HTML, JSON, XML@stable
: is the searx engine stable ?@parse
: what kind of data the searx engine return ?IMO:
@stable
without update will be wrong:@results
=HTML
is enough to understand that searx engine is "unstable".@parse
: is it useful ? I suggest to remove this attributeIn this PR, these attributes are replaced by a variable:
The
wikidata_id
is interesting for different purposes:How to test this PR locally?
about
is not used, there is nothing to test.Author's checklist
Related issues
WIP
about
section for engines using thejson
orxpath
engines.searx.engines.__init__