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 doctest errors in sudoku puzzle tutorial #82

Merged
merged 1 commit into from
Dec 28, 2024

Conversation

Fe-r-oz
Copy link
Contributor

@Fe-r-oz Fe-r-oz commented Dec 28, 2024

Based on the output on GitHub actions, the are a few doctests errors left. It seems that for Script examples, using # output is necessary to display the output and using ; does not suppress output. I used ; to suppress the output and then # output which displayed the output which causes doctests errors.

Apologies for the inconvenience. Hopefully, this will reduce the number of doctests errors.

TODO: Use CI Documentation to detect these doctests/documentation errors when the CI runs after submitting a PR.

@elsoroka
Copy link
Owner

elsoroka commented Dec 28, 2024

honestly I am always having doctest errors...doctest seems to be too sensitive. Sometimes when I run the docs on my own computer (docs/make.jl) and it works, it has errors in github actions.

Copy link

codecov bot commented Dec 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.34%. Comparing base (41ab35f) to head (f179b13).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #82   +/-   ##
=======================================
  Coverage   90.34%   90.34%           
=======================================
  Files          12       12           
  Lines        1015     1015           
=======================================
  Hits          917      917           
  Misses         98       98           

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

@Fe-r-oz Fe-r-oz marked this pull request as ready for review December 28, 2024 05:48
@Fe-r-oz
Copy link
Contributor Author

Fe-r-oz commented Dec 28, 2024

Thanks so much for your patience!

@elsoroka
Copy link
Owner

Thank you for contributing these examples...you seem very interested in this package, if you message me on linkedin we can discuss it (I tried but could not send a connection request)

@elsoroka elsoroka merged commit dfb5585 into elsoroka:main Dec 28, 2024
4 checks passed
@Fe-r-oz Fe-r-oz deleted the fa/doc-fix branch December 28, 2024 07:00
@Fe-r-oz
Copy link
Contributor Author

Fe-r-oz commented Dec 28, 2024

Thank you for the reminder! Yeah, that would be great. Apologies for the inconvenience, I think it was due to connection request settings that we couldn't connect earlier.

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