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

[DOP-14061] Replace asserts in documentation with doctest style #273

Merged
merged 1 commit into from
May 20, 2024

Conversation

dolfinus
Copy link
Member

@dolfinus dolfinus commented May 17, 2024

Change Summary

Instead of syntax:

assert some == "other"

Use doctest style:

>>> some
"other"

This should make examples easier to understand. See https://onetl--273.org.readthedocs.build/en/273/.

Also run pytest on these docstrings, to increase coverage.

Related issue number

Checklist

  • Commit message and PR title is comprehensive
  • Keep the change as small as possible
  • Unit and integration tests for the changes exist
  • Tests pass on CI and coverage does not decrease
  • Documentation reflects the changes where applicable
  • docs/changelog/next_release/<pull request or issue id>.<change type>.rst file added describing change
    (see CONTRIBUTING.rst for details.)
  • My PR is ready to review.

Copy link

codecov bot commented May 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.68%. Comparing base (24660e5) to head (de20bd5).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #273      +/-   ##
===========================================
+ Coverage    94.46%   94.68%   +0.21%     
===========================================
  Files          204      204              
  Lines         8047     8047              
  Branches      1409     1409              
===========================================
+ Hits          7602     7619      +17     
+ Misses         320      305      -15     
+ Partials       125      123       -2     

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

@dolfinus dolfinus merged commit aa2b753 into develop May 20, 2024
41 checks passed
@dolfinus dolfinus deleted the feature/DOP-14061 branch May 20, 2024 14:29
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.

None yet

2 participants