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

Ensure examples in linter docs #2288

Merged
merged 3 commits into from
Nov 16, 2023
Merged

Ensure examples in linter docs #2288

merged 3 commits into from
Nov 16, 2023

Conversation

MichaelChirico
Copy link
Collaborator

Thanks @IndrajeetPatil for catching the mistake of sample_int_linter() lacking examples. I added those, and looked for other doc pages lacking @examples -- a few more slipped through as well.

Therefore I added a regression test to guard against this going forward.

@codecov-commenter
Copy link

codecov-commenter commented Nov 15, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5674008) 99.64% compared to head (29f8ce2) 99.64%.
Report is 2 commits behind head on main.

❗ Current head 29f8ce2 differs from pull request most recent head 01a38e0. Consider uploading reports for the commit 01a38e0 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2288   +/-   ##
=======================================
  Coverage   99.64%   99.64%           
=======================================
  Files         115      115           
  Lines        5290     5290           
=======================================
  Hits         5271     5271           
  Misses         19       19           

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

@MichaelChirico MichaelChirico merged commit 08d7396 into main Nov 16, 2023
19 of 20 checks passed
@MichaelChirico MichaelChirico deleted the ensure-examples branch November 16, 2023 06:50
Copy link
Collaborator

@IndrajeetPatil IndrajeetPatil left a comment

Choose a reason for hiding this comment

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

Sorry, again, for reviewing after the PR has already been merged, but I can't do any open-source during work hours.

Thanks for adding the examples and the tests!

One thing I noticed is that we are not following the pattern we were following in all existing examples:

# will produce lints
example_with_lints

# okay
the_same_example_without_lints

The examples here don't have the same one-to-one correspondence between with and without lint code examples.

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.

4 participants