doc(readme): simplify renderJsonSchema description in readme

CodinGame · Feb 14, 2024 · a571102 · a571102
1 parent 32668b8
commit a571102
Showing 1 changed file with 2 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -27,7 +27,5 @@ The implemented functions are:
   - takes in parameters a schema with localized descriptions and the locale for which we want the description (default value is `'en'`)
   - returns the description for the wanted locale, or `undefined` if not found
 - `renderJsonSchema`:
-  - it can take in parameters the locale for which we want the description and a schema with localized descriptions and returns the `JSONSchema6` equivalent with the selected locale
-  - it can take in parameters the locale for which we want the description and a boolean and returns the boolean
-  - it can take in parameters the locale for which we want the description and an undefined schema and returns `undefined`
-  - it can take in parameters the locale for which we want the description and an optional schema with localized descriptions or boolean and returns the `JSONSchema6Definition` equivalent with the selected locale
+  - takes in parameters the locale for which we want the description and a schema with localized descriptions
+  - returns the `JSONSchema6` equivalent with the selected locale