Skip to content

Docs: write booleans in lowercase in the user manual - #466

Open
madsik wants to merge 1 commit into
buildingSMART:developmentfrom
madsik:docs-boolean-lowercase
Open

madsik wants to merge 1 commit into
buildingSMART:developmentfrom
madsik:docs-boolean-lowercase

Conversation

@madsik

@madsik madsik commented Nov 16, 2026

Copy link
Copy Markdown

The user manual writes boolean values in capitals in four places:

  • restrictions.md: "a boolean (TRUE / FALSE)" in the introduction, and "TRUE" or "FALSE" (twice) in the Enumeration section.
  • specifications.md: the Property row of the facet table ("LoadBearing" set to "TRUE", twice) and the first example ("Value is TRUE").

Since #290 (fixed in #292), booleans follow xs:boolean, which allows only true, false, 1 and 0 (DataTypes.md), and the test cases were renamed to match: attribute/invalid-booleans_must_be_specified_as_lowercase_strings_2_3 and property/invalid-booleans_must_be_specified_as_lowercase_strings_3_3 are invalid because they write FALSE. The manual still follows the old rule, so a reader who follows it writes an IDS that the test cases call invalid.

This pull request changes the four places to "true" and "false", and says once, in the introduction of restrictions.md, that booleans are written in lowercase.

One sentence I left as it is: the Enumeration section says a boolean may be given as an enumeration, but DataTypes.md allows only a pattern on xs:boolean (XML Schema has no enumeration facet for it either). I can correct it here or separately, as you prefer.

Prepared with the help of Claude. I have read every line and will answer the review myself.

restrictions.md and specifications.md wrote boolean values as "TRUE" and
"FALSE". IDS reads booleans as xs:boolean, whose values are lowercase
(DataTypes.md), and the test cases say so:
attribute/invalid-booleans_must_be_specified_as_lowercase_strings_2_3 and
property/invalid-booleans_must_be_specified_as_lowercase_strings_3_3 are
invalid because they use "FALSE". A reader who follows the manual writes
an invalid IDS. This changes the four places to "true" and "false".

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

1 participant