From 103ad364f9f76a9d7e3c66d8845b166fe1ec5287 Mon Sep 17 00:00:00 2001
From: Pieter Vander Vennet <pietervdvn@posteo.net>
Date: Mon, 3 Feb 2025 14:04:25 +0100
Subject: [PATCH] Docs: improve docs

---
 src/Logic/Search/GeocodingProvider.ts | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/Logic/Search/GeocodingProvider.ts b/src/Logic/Search/GeocodingProvider.ts
index 2e21f04819..a698e3aa9d 100644
--- a/src/Logic/Search/GeocodingProvider.ts
+++ b/src/Logic/Search/GeocodingProvider.ts
@@ -50,6 +50,12 @@ export interface GeocodingOptions {
 
 export default interface GeocodingProvider {
     readonly name: string
+
+    /**
+     * Performs search.
+     * Note: the result _must_ return an empty list in the case of no results.
+     * Undefined might be interpreted by clients as "still running"
+     */
     search(query: string, options?: GeocodingOptions): Promise<GeocodeResult[]>
 
     /**