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.

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

DOC: Add usage instructions for running from deno.land #1770

Merged
merged 3 commits into from
Aug 24, 2023

Conversation

effigies
Copy link
Collaborator

@effigies effigies commented Aug 4, 2023

The current README is overly developer-focused. This adds docs that will appear on the deno.land landing page (https://deno.land/x/bids_validator) that tell users how to use what's there.

@effigies effigies requested a review from nellh August 4, 2023 18:00
@codecov
Copy link

codecov bot commented Aug 4, 2023

Codecov Report

Patch coverage has no change and project coverage change: -2.32% ⚠️

Comparison is base (5ec0b3d) 85.71% compared to head (0adb522) 83.40%.
Report is 9 commits behind head on master.

❗ Current head 0adb522 differs from pull request most recent head 04d3fd2. Consider uploading reports for the commit 04d3fd2 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1770      +/-   ##
==========================================
- Coverage   85.71%   83.40%   -2.32%     
==========================================
  Files         130       92      -38     
  Lines        6575     3893    -2682     
  Branches     1524     1270     -254     
==========================================
- Hits         5636     3247    -2389     
+ Misses        833      548     -285     
+ Partials      106       98       -8     

see 38 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@sappelhoff sappelhoff left a comment

Choose a reason for hiding this comment

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

thanks!

Copy link
Member

@nellh nellh left a comment

Choose a reason for hiding this comment

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

Looks good except we should update the --legacy option docs since it was removed.

bids-validator/src/README.md Outdated Show resolved Hide resolved
@nellh nellh merged commit 1e8de01 into bids-standard:master Aug 24, 2023
19 of 22 checks passed
@effigies effigies deleted the doc/deno-instructions branch August 24, 2023 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants