docs: fix stale signature output in Elixir README examples#6088
Open
prql-bot wants to merge 1 commit into
Open
docs: fix stale signature output in Elixir README examples#6088prql-bot wants to merge 1 commit into
prql-bot wants to merge 1 commit into
Conversation
The examples pinned `compiler version 0.3.1` and an outdated signature format. Mirror the binding's own doctests (`signature_comment: false`) so the shown output is the stable SQL and doesn't drift with each release.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Nightly survey finding. The
Basic Usageexamples in the Elixir binding README (also rendered in the book atproject/bindings/elixir.md) showed stale output:-- Generated by PRQL compiler version 0.3.1 (https://prql-lang.org). The version is long out of date (workspace is now 0.13.x), and the format itself changed — the current signature is-- Generated by PRQL compiler version:{version} {target}(https://prql-lang.org)(note the colon and target segment; seeprqlc/src/sql/mod.rs).Rather than re-pin a version that will drift again, this matches the convention the binding's own
@docdoctests already use (lib/prql.ex): passsignature_comment: falseso the example output is the stable SQL only. The new README output is copied verbatim from thosemix test-verified doctests, so it stays correct across version bumps.No separate regression test: the README prose isn't executed, but the outputs shown are exactly the strings asserted by the existing
lib/prql.exdoctests, which CI runs.