Skip to content

Commit ea8f6ff

Browse files
author
Tjaž Eržen
authored
Merge pull request #36 from Codeplain-ai/feat/update-docs-for-concept-names
Update documentation for defining concepts
2 parents 3ff50fb + a5c7970 commit ea8f6ff

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

docs/plain_language_specification.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,9 @@ In this case, the concept name is `:App:`. Concepts are important for refering t
8787
While providing definitions, you should adhere to the following 4 rules:
8888

8989
- Every definition must start with the name of the concept you are defining.
90-
- Every concept name starts and ends with colon (`:`) following by concept name in PascalCase. Examples: `:App:`, `:Tasks:`, `:ListOfUsers:`, `:CLI:`.
90+
- Each concept name must be enclosed in colons (`:`) at both the beginning and end.
91+
- Valid characters for concept name include: Plus sign (`+`), Minus sign (`-`), Dot sign (`.`), Digits (`0`-`9`), Uppercase letters (`A`-`Z`), Underscore (`_`), Lowercase letters (`a`-`z`)
92+
- Examples: `:App:`, `:Tasks:`, `:ListOfUsers:`, `:CLI:`.
9193
- Concept names must be globally unique (meaning, you cannot provide two definitions with the same concept name).
9294
- When referencing concepts in ***Test Requirements:***, ***Functional Requirements:***, ***Non-Functional Requirements:*** and ***Acceptance Tests:***, the concept name must exist in the ***Definitions:*** section.
9395

0 commit comments

Comments
 (0)