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

Add positive examples #175

Merged
merged 20 commits into from
Jul 1, 2024
Merged

Add positive examples #175

merged 20 commits into from
Jul 1, 2024

Conversation

klwetstone
Copy link
Contributor

@klwetstone klwetstone commented Jun 13, 2024

works on #169

  • Adds positive examples
  • Changes the language describing the examples to include both negative and positive
  • Revamps the "background" section on deon's homepage to make the information more navigable. I didn't change any of the wording, just reordered and did some formatting
  • Removes a link to a "Related academic study" when the academic study is clearly linked from the primary article

Only the .yml and .tpl files are updated. README.md, index.md, and examples.md should all get updated when make docs is run in the github actions. If it's easier, I can also track the changes to the markdown files.

Future work

  • continue adding more positive examples. Try to get close to 1 per checklist item / slightly more balanced between positive and negative.

Copy link

codecov bot commented Jun 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.80%. Comparing base (f39f293) to head (f185970).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #175   +/-   ##
=======================================
  Coverage   96.80%   96.80%           
=======================================
  Files           6        6           
  Lines         188      188           
=======================================
  Hits          182      182           
  Misses          6        6           

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

@ejm714 ejm714 requested a review from pjbull June 24, 2024 16:51
Copy link
Member

@pjbull pjbull left a comment

Choose a reason for hiding this comment

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

This looks great to me, thanks @klwetstone!

@pjbull pjbull merged commit da8a8f1 into main Jul 1, 2024
23 checks passed
@pjbull pjbull deleted the 169-positive-examples branch July 1, 2024 04:39
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