Skip to content

Commit bbf5387

Browse files
authored
Doc: Clarify requirements for IDs (#484)
The general comment was repeatedly overlooked. Therefore, now added directly to the respective field descriptions.
1 parent b89dfd9 commit bbf5387

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

doc/documentation_data_format.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,6 @@ problem as such.
5858
**General remarks**
5959

6060
- All model entities, column names and row names are case-sensitive
61-
- All identifiers must consist only of upper and lower case letters, digits and
62-
underscores, and must not start with a digit.
6361
- Fields in "[]" are optional and may be left empty.
6462

6563

@@ -104,7 +102,8 @@ Detailed field description
104102
- ``conditionId`` [STRING, NOT NULL]
105103

106104
Unique identifier for the simulation/experimental condition, to be referenced
107-
by the measurement table described below.
105+
by the measurement table described below. Must consist only of upper and
106+
lower case letters, digits and underscores, and must not start with a digit.
108107

109108
- ``conditionName`` [STRING, OPTIONAL]
110109

@@ -297,9 +296,9 @@ Detailed field description
297296

298297
* ``observableId`` [STRING]
299298

300-
Any identifier which would be a valid identifier in SBML. This is referenced
301-
by the ``observableId`` column in the measurement table. Must be different from
302-
any existing model entity or parameter introduced elsewhere.
299+
Unique identifier for the given observable. Must consist only of upper and
300+
lower case letters, digits and underscores, and must not start with a digit.
301+
This is referenced by the ``observableId`` column in the measurement table.
303302

304303
* [``observableName``] [STRING, OPTIONAL]
305304

0 commit comments

Comments
 (0)