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

Fix some typos in the gallery examples #1825

Merged
merged 3 commits into from
Jan 16, 2024

Conversation

zm711
Copy link
Contributor

@zm711 zm711 commented Jan 16, 2024

Motivation

Just noticed some typos in the gallery and tried to clarify a couple things. (Also and maybe this is just me but I really prefer calling it simulated data in examples because fake data has such a negative connotation).

What was the reasoning behind this change? Please explain the changes briefly.
Fix typos. Try to clarify a couple points.
Add articles when missing. Ad ly to adverbs. Use correct modal verb. Switch a few places to a more standard US-English positioning of words. Switched fake -> simulated.

I'm happy to do some more docs read throughs, but I figured it is easier to do this in smaller batches. Let me know if you'd prefer a different format for the PRs for docs only.

How to test the behavior?

No testing. Just the written portion of the gallery docs. No changes to the functions themselves.

Checklist

  • Did you update CHANGELOG.md with your changes? Do you want this for a doc change?
  • Have you checked our Contributing document?
  • Have you ensured the PR clearly describes the problem and the solution?
  • Is your contribution compliant with our coding style? This can be checked running flake8 from the source directory.
  • Have you checked to ensure that there aren't other open Pull Requests for the same change?
  • Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged. NA

Copy link

codecov bot commented Jan 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (82c4f2b) 91.99% compared to head (c214f74) 83.68%.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev    #1825      +/-   ##
==========================================
- Coverage   91.99%   83.68%   -8.32%     
==========================================
  Files          27       27              
  Lines        2623     2623              
  Branches      685      685              
==========================================
- Hits         2413     2195     -218     
- Misses        138      344     +206     
- Partials       72       84      +12     
Flag Coverage Δ
integration ?
unit 83.68% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

rly
rly previously approved these changes Jan 16, 2024
@rly
Copy link
Contributor

rly commented Jan 16, 2024

This is great! Thank you for fixing all of these, @zm711 . I added a changelog entry to give you more visible credit for your contributions.

@rly rly enabled auto-merge (squash) January 16, 2024 20:00
@rly rly merged commit dfc19bd into NeurodataWithoutBorders:dev Jan 16, 2024
22 of 23 checks passed
@zm711 zm711 deleted the docs-updates branch January 16, 2024 20:41
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.

2 participants