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] Clearer DOCs for session and participant IDs #226

Merged
merged 11 commits into from
Sep 24, 2024
Merged

[ENH] Clearer DOCs for session and participant IDs #226

merged 11 commits into from
Sep 24, 2024

Conversation

surchs
Copy link
Contributor

@surchs surchs commented Sep 23, 2024 •
edited
Loading

Changes proposed in this pull request:

  • start adopting standard requirements language (see Use standard requirement level words #227)
  • reformat requirements for TSVs
  • clarify the requirements regarding participant and session IDs
  • clarify a section on multiple session / participant colums
  • refactor the getting-started section into its own directory to address an older issue

Checklist

Please leave checkboxes empty for PR reviewers

  • PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF]) see our Contributing Guidelines for more info)
  • PR links to GitHub issue with mention Closes #XXXX
  • Checks pass

@netlify Netlify
Copy link

netlify bot commented Sep 23, 2024 •
edited
Loading

✅ Deploy Preview for neurobagel-documentation ready!

Name Link
🔨 Latest commit 6af44c0
🔍 Latest deploy log https://app.netlify.com/sites/neurobagel-documentation/deploys/66f2fb339b290500089dbb69
😎 Deploy Preview https://deploy-preview-226--neurobagel-documentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@surchs
[ENH] Use MUST keyword
3130823 
Also some overlength line breaks
@surchs
[ENH] Clarify required columns
c214186
@surchs
[ENH] Clarify requirements for session IDs
a4fed8c 
- Also include a clarification in the section
  on multiple participants or sessions
@surchs surchs marked this pull request as ready for review September 23, 2024 20:29
@alyssadai alyssadai self-requested a review September 24, 2024 00:34
alyssadai
alyssadai reviewed Sep 24, 2024
View reviewed changes
Copy link
Contributor

@alyssadai alyssadai left a comment

Choose a reason for hiding this comment

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

Hey @surchs, thanks for the PR!

A few suggestions below, incl. one about the overall docs structure - lmkwyt!

docs/data_prep.md Outdated Show resolved Hide resolved
docs/data_prep.md Outdated Show resolved Hide resolved
docs/data_prep.md Outdated Show resolved Hide resolved
docs/data_prep.md Outdated Show resolved Hide resolved
docs/data_prep.md Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
alyssadai
alyssadai approved these changes Sep 24, 2024
View reviewed changes
Copy link
Contributor

@alyssadai alyssadai left a comment

Choose a reason for hiding this comment

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

Looking good!! One 🍒 below I just thought of, otherwise 🧑‍🍳

docs/data_prep.md Outdated Show resolved Hide resolved
@surchs @alyssadai
Update docs/data_prep.md
6af44c0 
Co-authored-by: Alyssa Dai <[email protected]>
@surchs surchs merged commit a73f6d7 into main Sep 24, 2024
5 of 6 checks passed
@surchs surchs deleted the documentation-182 branch September 24, 2024 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alyssadai alyssadai alyssadai approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Clearer documentation around participant/session IDs
2 participants
@surchs @alyssadai