Skip to content

Conversation

@Fe-r-oz
Copy link

@Fe-r-oz Fe-r-oz commented Oct 12, 2024

This PR aims to fix documentation build, misc bugs and add doctests.

@Fe-r-oz Fe-r-oz force-pushed the doctests branch 2 times, most recently from def5c17 to 07b4b28 Compare October 12, 2024 06:30
@Fe-r-oz Fe-r-oz changed the title doc build diagnostics fix documentation build and add doctests Oct 12, 2024
@Fe-r-oz Fe-r-oz force-pushed the doctests branch 4 times, most recently from 94706f5 to 595df07 Compare October 12, 2024 07:28
@Fe-r-oz Fe-r-oz changed the title fix documentation build and add doctests fix documentation build, misc bugs and add doctests Oct 12, 2024
@Fe-r-oz Fe-r-oz force-pushed the doctests branch 2 times, most recently from 48d9531 to 6952021 Compare October 12, 2024 10:32
@Fe-r-oz Fe-r-oz marked this pull request as ready for review October 12, 2024 10:37
@Fe-r-oz
Copy link
Author

Fe-r-oz commented Oct 12, 2024

@esabo, The PR is ready review, Thank you!

P.S. Added more doctests as well.

@Fe-r-oz Fe-r-oz force-pushed the doctests branch 2 times, most recently from 09168c6 to 7fbf902 Compare October 12, 2024 15:11
Copy link
Owner

@esabo esabo left a comment

Choose a reason for hiding this comment

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

So I guess one question is whether or not we want to move these doc tests to tutorials or actual docs and out of the doc strings themselves?

@Fe-r-oz
Copy link
Author

Fe-r-oz commented Oct 13, 2024

I think tutorials require documentation about the code itself as well as seen from other tutorials. I think we can have docstrings in the tutorial as well once we write about weight reduction for example. There seems to be a bug, I have reported it to HQ.

I think even MethodTypingSignature didn't removed the warnings:

 │  ┌ Warning: Unable to install the GAP packages LINS.
│  └ @ CodingTheory ~/work/CodingTheory/CodingTheory/src/CodingTheory.jl:41
│  ┌ Warning: Replacing docs for `CodingTheory.weight_plot :: Union{}` in module `CodingTheory`
│  └ @ Base.Docs docs/Docs.jl:243

Documentation build passes now most of the time, as seen from actions, it's the build runner CI sometime didn't run so the error this time.

@esabo
Copy link
Owner

esabo commented Nov 6, 2024

I'd like to get this pulled in. What's the status of this?

@Fe-r-oz
Copy link
Author

Fe-r-oz commented Nov 6, 2024

LGTM as documentation build passes.

@esabo esabo merged commit f15c13c into esabo:dev Nov 12, 2024
1 check passed
@Fe-r-oz Fe-r-oz deleted the doctests branch November 12, 2024 16:55
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