Skip to content

Commit feddf1e

Browse files
authored
fix: missing to correctly display markdown wrapped in <> (#33)
* fix: missing ` ` to correctly display markdown wrapped in <> * docs: fix a missing `
1 parent ba09070 commit feddf1e

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

docs/source/philosophy/data_organization.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,14 @@ All data acquired in a single acquisition session will be stored together. This
5454

5555
All primary data assets have the following naming convention:
5656

57-
<subject-id>_<acquisition-start-datetime>
57+
`<subject-id>_<acquisition-start-datetime>`
5858

5959
A few points:
6060

61-
- Format <acquisition-start-datetime>: yyyymmdd_HH-MM-SS
61+
- Format `<acquisition-start-datetime>: yyyymmdd_HH-MM-SS`
6262
- This should be the start of acquisition, in the local time zone.
6363
- The local time-zone is documented in metadata files
64-
- All tokens (e.g. <subject-id>) must not contain underscores or illegal filename characters. Subject ID is not strictly necessary – only the timestamp is essential. However, it is part of the current naming convention because it helps people visually browse for data.
64+
- All tokens (e.g. `<subject-id>`) must not contain underscores or illegal filename characters. Subject ID is not strictly necessary – only the timestamp is essential. However, it is part of the current naming convention because it helps people visually browse for data.
6565

6666
Primary data assets are organized as follows:
6767

@@ -127,14 +127,14 @@ Example for exaSPIM data:
127127

128128
Anything computed in a single run should be logically grouped in a folder. The folder should be named:
129129

130-
<primary-asset-name>_<process-label>_<process-date>_<process-time>
130+
`<primary-asset-name>_<process-label>_<process-date>_<process-time>`
131131

132132
Examples:
133133

134134
- ANM457202_2022-07-11_22-11-32_processed_2022-08-11_22-11-32
135135
- 595262_2022-02-21_15-18-07_processed_2022-08-11_22-11-32
136136

137-
Processed outputs are usually the result of a multi-stage pipeline handling a single data modality. Utilize a modality-specific <process-label>. Other common process labels include:
137+
Processed outputs are usually the result of a multi-stage pipeline handling a single data modality. Utilize a modality-specific `<process-label>`. Other common process labels include:
138138

139139
- “curation” - tags assigned to input data (e.g. merge/split/noise calls for ephys units)
140140
- ...

0 commit comments

Comments
 (0)