Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[ENH] Clearly define "entity" in common principles #947

Merged
merged 10 commits into from
Jun 8, 2022
Merged

[ENH] Clearly define "entity" in common principles #947

Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
bdd3c96
[FIX] Common principles: Add "entity" to list of definitions
Lestropie Dec 5, 2021
00f9cea
Common principles: Link "entity" definition to appendices
Lestropie Dec 8, 2021
34c85b6
Standardise use of "entity" definition across specification
Lestropie Dec 8, 2021
6b81d67
Merge pull request #1 from Lestropie/replace_keyvalue_entity
Lestropie Dec 12, 2021
ae80901
Common principles: More elaborate "entity" definition
Lestropie Apr 14, 2022
470eb09
Common principles: Reformmating of Entity definition changes
Lestropie Apr 26, 2022
bb3f70e
Common principles: Remark fixes
Lestropie Apr 26, 2022
f3df02b
Merge pull request #4 from Lestropie/entity_refined_definition
Lestropie Apr 29, 2022
699b74e
Merge branch 'master' into define_entity
Lestropie Apr 29, 2022
fd3682c
Merge branch 'master' into define_entity
sappelhoff Apr 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/02-common-principles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,12 @@ misunderstanding we clarify them here.
The modality may overlap with, but should not be confused with
the **data type**.

1. **Entity** - a portion of a file name, consisting of a **key** and corresponding
**value** separated by a hyphen. Supported entities are defined in
[Appendix IX](99-appendices/09-entities.md); further, whether they are allowed,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't think of a case that is allowed but neither OPTIONAL or REQUIRED, so we should avoid introducing a term that implies a distinction.

Suggested change
[Appendix IX](99-appendices/09-entities.md); further, whether they are allowed,
[Appendix IX](99-appendices/09-entities.md); further, whether they are

OPTIONAL or REQUIRED for various data files, as well as their relative ordering,
are defined in the Entity Table in [Appendix IV](99-appendices/04-entity-table.md).

1. **`<index>`** - a nonnegative integer, possibly prefixed with arbitrary number of
0s for consistent indentation, for example, it is `01` in `run-01` following
`run-<index>` specification.
Expand Down