From 5ca9208c7a039bfd8fbae5360bef04dc528ee3e5 Mon Sep 17 00:00:00 2001 From: Niko Strijbol Date: Wed, 24 Jan 2024 23:29:21 +0100 Subject: [PATCH] Do an editorial pass over the docs --- api-resto-02.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/api-resto-02.md b/api-resto-02.md index 7e361614..f41bfb85 100644 --- a/api-resto-02.md +++ b/api-resto-02.md @@ -6,7 +6,7 @@ The resto API provides information about the student restaurants of Ghent Univer These data are scraped from https://www.ugent.be/student/nl/meer-dan-studeren/resto. -The menu data is property of Ghent University. We don't guarantee the correctness or completeness of the data. +The menu data is property of Ghent University. We do not guarantee the correctness or completeness of the data. ## Versioning and status @@ -291,21 +291,21 @@ A vegetable object consists of: |-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `kind` | The kind of the vegetable. A subset of the meal kind, currently `meat`, `vegetarian`, or `vegan`. Applications must be able to handle changes to the possible values. | | `name` | The name of the vegetable. | -| `allergens` | List of allergens, matched on a best-efforts basis from the [allergen information](#allergen-information). | +| `allergens` | List of allergens, matched on a best-effort basis from the [allergen information](#allergen-information). | > **Warning** > The allergen information, like all other information in the API, is available on a best-effort basis. > Particularly, this information IS NOT FIT to replace the legally mandated information about allergens. > When showing these data to users, please inform them of this and link to the web page. -How an application handles changes to possible values (indicated above where this is applicable), is not specified. +How an application handles changes to possible values (indicated above where this is applicable) is not specified. The application might simply ignore new values. ### Regular sandwiches **Endpoint**: `GET /sandwiches/static.json` -Lists available regular sandwiches, their price and their ingredients. Sample output: +Lists available regular sandwiches, their price, and their ingredients. Sample output: ```json [ @@ -346,9 +346,9 @@ as [Weekly sandwiches yearly](#weekly-sandwiches-yearly). - _year_ -- Which year you want the sandwiches of. Values must be a positive integer. Currently, the earliest available year is 2019 (but this might change in the future). ISO format: `YYYY`. -Starting in academic year 2020-2021, this is listed as "groentespread". +Starting in academic year 2020–2021, this is listed as "groentespread". -Lists all sandwiches which were or are available in the specified year. Sample output: +List all sandwiches that were or are available in the specified year. Sample output: ```json [ @@ -407,7 +407,7 @@ Since that webpage is made manually, it is very possible that the names used her menu. > **Warning** -> This parser, as all other information in the API, is available on a best-efforts basis. +> This parser, as all other information in the API, is available on a best-effort basis. > Particularly, this information IS NOT FIT to replace the legally mandated information about allergens. > When showing these data to users, please inform them of this and link to the web page.