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

[DOC] update schema and schema tools doc #1504

Merged
merged 11 commits into from
Jun 1, 2023
Merged

[DOC] update schema and schema tools doc #1504

merged 11 commits into from
Jun 1, 2023

Conversation

Remi-Gau
Copy link
Collaborator

@Remi-Gau Remi-Gau commented May 25, 2023 •
edited
Loading

relates #1499

  • creates symlink between the src/schema/README.md and a file that will be rendered in the bids tools doc
  • clean up of that document (some semantic line break and ordering some tables entries alphabetically)
  • add some links in the README of the bids schema tools

@codecov
Copy link

codecov bot commented May 25, 2023 •
edited
Loading

Codecov Report

Patch and project coverage have no change.

Comparison is base (5aa43cd) 87.80% compared to head (7203766) 87.80%.

❗ Current head 7203766 differs from pull request most recent head e9a81c0. Consider uploading reports for the commit e9a81c0 to get more accurate results

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #1504   +/-   ##
=======================================
  Coverage   87.80%   87.80%           
=======================================
  Files          14       14           
  Lines        1287     1287           
=======================================
  Hits         1130     1130           
  Misses        157      157

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@Remi-Gau Remi-Gau marked this pull request as ready for review May 25, 2023 21:25
effigies
effigies reviewed May 26, 2023
View reviewed changes
Copy link
Collaborator

@effigies effigies left a comment

Choose a reason for hiding this comment

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

Awesome! Thanks!

Some small cleanups.

src/schema/README.md Outdated Show resolved Hide resolved
src/schema/README.md Outdated Show resolved Hide resolved
src/schema/README.md Show resolved Hide resolved
src/schema/README.md Outdated Show resolved Hide resolved
tools/schemacode/README.md Outdated Show resolved Hide resolved
tools/schemacode/docs/index.rst Outdated Show resolved Hide resolved
Remi-Gau and others added 2 commits May 26, 2023 14:58
@Remi-Gau @effigies
Update src/schema/README.md
197bb0b 
Co-authored-by: Chris Markiewicz <[email protected]>
@Remi-Gau @effigies
Apply suggestions from code review
7203766 
Co-authored-by: Chris Markiewicz <[email protected]>
@effigies effigies added schema-code Updates or changes to the code used to parse, filter, and render the schema. exclude-from-changelog This item will not feature in the automatically generated changelog labels May 26, 2023
tsalo
tsalo approved these changes May 31, 2023
View reviewed changes
Copy link
Member

@tsalo tsalo left a comment

Choose a reason for hiding this comment

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

I looked through the changes and the rendered docs, and both look good to me. Thanks!

@effigies effigies merged commit b879ae0 into bids-standard:master Jun 1, 2023
@Remi-Gau Remi-Gau deleted the schema_doc branch September 7, 2023 19:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@effigies effigies effigies approved these changes

@tsalo tsalo tsalo approved these changes

@erdalkaraca erdalkaraca Awaiting requested review from erdalkaraca erdalkaraca is a code owner

Assignees
No one assigned
Labels
exclude-from-changelog This item will not feature in the automatically generated changelog schema-code Updates or changes to the code used to parse, filter, and render the schema.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Remi-Gau @effigies @tsalo