Mousetrap.jl icon indicating copy to clipboard operation
Mousetrap.jl copied to clipboard

Example code is not tested or run

Open LilithHafner opened this issue 1 year ago • 3 comments
trafficstars

This leads to issues like https://github.com/Clemapfel/Mousetrap.jl/pull/65 https://github.com/Clemapfel/Mousetrap.jl/pull/62 https://github.com/Clemapfel/Mousetrap.jl/pull/56

LilithHafner avatar Jan 27 '24 14:01 LilithHafner

I agree, the main issue is that Documenter.jl doctest macro does not work with Mousetrap, as it needs to create a new window and application instance anytime any of the code snippets is run, since they are all completely sandboxed.

You are still right though, I should find another automated system to run all the example snippets

Clemapfel avatar Feb 08 '24 05:02 Clemapfel

Fixed by multiple commits such as https://github.com/Clemapfel/Mousetrap.jl/commit/b72910a73078873423d68faeea98ac52041a7aa4, all runnable code in the docs is now run once when the docs are built, avoiding future typos.

This fix will go live with 3.4

Clemapfel avatar Feb 11 '24 18:02 Clemapfel

Thank you! Well done! Yay!

LilithHafner avatar Feb 11 '24 20:02 LilithHafner