search

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

Consider adding a note in docs about pinning version of `TranscodingStreams` #45

Closed neelsmith closed 1 year ago

neelsmith commented 1 year ago

Since current versions of TranscodingStreams throw an error when invoked by Kroki, it would be helpful to Kroki users to be alerted to this, since the work around is as easy as pinning the version of TranscodingStreams to 0.9.11.

A note on the README and in the ghpages documentation would have saved me a little time and frustration, and prevented me from filing an issue here when the real bug is in TranscodingStreams.

bauglir commented 1 year ago

Unfortunately, I didn't expect the fix to take as long to land in a release as it did. Otherwise, a note like this would indeed have been useful. I'm sorry for the confusion. The underlying issue has been addressed in JuliaIO/TranscodingStreams.jl#141 and released through TranscodingStreams@0.9.13.

In general, I prefer not to work around issues in dependencies unless strictly necessary and this seemed like an easy fix. But I will keep this in mind for the future. Thanks for your feedback.