From b50d93d637624c3f598262e0f3eadd1438974dcb Mon Sep 17 00:00:00 2001 From: Rickard Armiento Date: Fri, 16 Jun 2023 03:35:17 +0200 Subject: [PATCH] Minor language corrections from review Co-authored-by: Giovanni Pizzi --- optimade.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/optimade.rst b/optimade.rst index 92ffe082e..2d77fe4ab 100644 --- a/optimade.rst +++ b/optimade.rst @@ -3524,8 +3524,8 @@ When data is fetched from these URLs the response MUST use the JSON lines partia The markers have been deliberately designed to be valid JSON objects but *not* valid OPTIMADE property values. Since the OPTIMADE list data type is defined as a list of values of the same data type or :val:`null`, the above markers cannot be encountered inside the actual data of an OPTIMADE property. - **Implementation note:** the recognizable string values for the markers should make it possible to prescreen the raw text of the JSON data lines for the reference-marker string to determine which lines that one can exclude from further processing to resolve references (alternatively, this screening can be done by the string parser used by the JSON parser). - The undelying design idea is that for lines that have reference-markers, the time it takes to process the data structure to locate the markers should be negliable compared to the time it takes to resolve and handle the large data they reference. + **Implementation note:** the recognizable string values for the markers should make it possible to prescreen the raw text of the JSON data lines for the reference-marker string to determine which are the lines that one can exclude from further processing to resolve references (alternatively, this screening can be done by the string parser used by the JSON parser). + The undelying design idea is that for lines that have reference-markers, the time it takes to process the data structure to locate the markers should be negligible compared to the time it takes to resolve and handle the large data they reference. Hence, the most relevant optimization is to avoid spending time processing data structures to find markers for lines where there are none. The full response MUST be valid `JSON Lines `__ that adheres to the following format: