From 4f52f84c9dbf76e4e9b22c432907e17e1a5ee6da Mon Sep 17 00:00:00 2001 From: Sebastian Felix Zappe Date: Tue, 15 Aug 2023 13:01:33 +0200 Subject: [PATCH] Update docs --- docs/describing-objects/constants.md | 6 +++--- docs/describing-objects/interfaces.md | 5 +++-- docs/describing-objects/type-aliases.md | 4 ++-- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/describing-objects/constants.md b/docs/describing-objects/constants.md index b2f8ac7..6f76e92 100644 --- a/docs/describing-objects/constants.md +++ b/docs/describing-objects/constants.md @@ -486,7 +486,7 @@ kilogram*meter/second^2.

### GenericInteractions -[:fontawesome-solid-code:](https://github.com/sozialhelden/a11yjson/blob/main/src/Accessibility.ts#L52) +[:fontawesome-solid-code:](https://github.com/sozialhelden/a11yjson/blob/main/src/Accessibility.ts#L53) @@ -551,7 +551,7 @@ Read-only tuple with 27 strings: ### GenericInteractionsSet -[:fontawesome-solid-code:](https://github.com/sozialhelden/a11yjson/blob/main/src/Accessibility.ts#L82) +[:fontawesome-solid-code:](https://github.com/sozialhelden/a11yjson/blob/main/src/Accessibility.ts#L83) @@ -2009,7 +2009,7 @@ Set<One of the following strings: ### WheelchairAccessibilityGrades -[:fontawesome-solid-code:](https://github.com/sozialhelden/a11yjson/blob/main/src/Accessibility.ts#L31) +[:fontawesome-solid-code:](https://github.com/sozialhelden/a11yjson/blob/main/src/Accessibility.ts#L32)

Describes the general wheelchair accessibility of the place. This is a human-rated value. It SHOULD conform to the traffic light system found in OpenStreetMap and Wheelmap.org.

diff --git a/docs/describing-objects/interfaces.md b/docs/describing-objects/interfaces.md index 457b1aa..0f280e9 100644 --- a/docs/describing-objects/interfaces.md +++ b/docs/describing-objects/interfaces.md @@ -13,7 +13,7 @@ them as they are, or mix them into your own entity definitions. ### Accessibility - [:fontawesome-solid-code:](https://github.com/sozialhelden/a11yjson/blob/main/src/Accessibility.ts#L87) + [:fontawesome-solid-code:](https://github.com/sozialhelden/a11yjson/blob/main/src/Accessibility.ts#L88)

Describes the physical (and sometimes human rated) accessibility of a place.

@@ -124,7 +124,8 @@ describe pathways from there to this place.

null indicates there is no payment possible/required, undefined or missing property indicates unknown.

queueSystemundefined | QueueSystem

Information about the place's queue system.

-restroomsundefined | Restroom[]

Describes the accessibility of restrooms in the place.

+restroomsundefined | Restroom[]

Describes the accessibility of restrooms that belong to the place.

+roomsundefined | Room[]

Describes the accessibility of rooms that belong to the place.

serviceContactLocalizedStringsignageSystemsSignage[]

Describes local signage systems. If multiple different systems are used, describe them all.

smokingPolicyOne of the following strings: diff --git a/docs/describing-objects/type-aliases.md b/docs/describing-objects/type-aliases.md index 9920245..b782578 100644 --- a/docs/describing-objects/type-aliases.md +++ b/docs/describing-objects/type-aliases.md @@ -308,7 +308,7 @@ Definition: Quantity | string ### GenericInteraction -[:fontawesome-solid-code:](https://github.com/sozialhelden/a11yjson/blob/main/src/Accessibility.ts#L81) +[:fontawesome-solid-code:](https://github.com/sozialhelden/a11yjson/blob/main/src/Accessibility.ts#L82) @@ -1316,7 +1316,7 @@ Definition: one of the following strings: ### WheelchairAccessibilityGrade -[:fontawesome-solid-code:](https://github.com/sozialhelden/a11yjson/blob/main/src/Accessibility.ts#L50) +[:fontawesome-solid-code:](https://github.com/sozialhelden/a11yjson/blob/main/src/Accessibility.ts#L51)