Skip to content

Commit

Permalink
[ENH] Ensure consistent indentation for comments in yaml files, addre…
Browse files Browse the repository at this point in the history
…ss yamllint warning (#1117)

* ENH: yamllint - ensure consistent indentation for comments

* BF: Address yamllint errors/warnings:

    $> yamllint -c .yamllint.yml src/schema/
    src/schema/rules/tabular_metadata.yaml
      10:23     error    too few spaces before comment  (comments)
      11:11     error    too few spaces before comment  (comments)

    src/schema/rules/checks/func.yaml
      1:1       warning  missing document start "---"  (document-start)
  • Loading branch information
yarikoptic authored Jun 9, 2022
1 parent 5f97a79 commit 24dbe58
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .yamllint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@ rules:
indentation:
# See https://github.com/yaml/pyyaml/issues/545 for why
indent-sequences: false
comments:
level: error
2 changes: 2 additions & 0 deletions src/schema/rules/checks/func.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Rules for functional data that are not defined in tables.
---
PhaseSuffixDeprecated:
issue:
code: PHASE_SUFFIX_DEPRECATED
Expand Down
4 changes: 2 additions & 2 deletions src/schema/rules/tabular_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ scans:
- .json
entities:
subject: required
session: optional # session is required if session is present in the dataset.
sessions: # This file may only exist if session is present in the dataset.
session: optional # session is required if session is present in the dataset.
sessions: # This file may only exist if session is present in the dataset.
suffixes:
- sessions
extensions:
Expand Down

0 comments on commit 24dbe58

Please sign in to comment.