bauglir / Kroki.jl

Supports creating a variety of diagrams through the https://kroki.io service.
https://bauglir.github.io/Kroki.jl/stable
MIT License
79 stars 3 forks source link

Remove dynamically generated example output from the `info` docstring #49

Closed bauglir closed 6 months ago

bauglir commented 6 months ago

The info function performs HTTP requests to the configured ENDPOINT to obtain an overview of the versions of the available tools for the specific Kroki instance. Including example output for it in the docstring of the function was a nice feature, but it hangs precompilation on Julia v1.10 and later due to the following^1:

Julia 1.10 and higher wait for all running Tasks to finish before writing out the precompiled (cached) version of the package. One consequence is that a package that launches Tasks in its __init__ function may precompile successfully, but block precompilation of any packages that depend on it.

To ensure the package does not hang precompilation and can be installed on Julia v1.10 and later the example output needs to be removed.

Fixes #48.

codecov[bot] commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (660a11c) to head (067eb40). Report is 5 commits behind head on development.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## development #49 +/- ## ============================================= Coverage 100.00% 100.00% ============================================= Files 4 5 +1 Lines 136 147 +11 ============================================= + Hits 136 147 +11 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.