Repository navigation
Rewrite the docs for Rue 0.12.0 - #12
Merged
Merged
Conversation
- Explain that a guard or cast must be parenthesized before combining it with | - Document that rue test runs every test in the project, even when given a file - Fix the duplicate_condition row in the lints table - Correct claims about tree_hash on external functions, field access on struct unions, generic inference, Bool length, function type compatibility and BLS scalar multiplication - Document dist_dir paths, export file names, the required [compiler] section, and that rue test doesn't check the version - Match rue fmt style in examples, and link to the lints page for unused names
- Use an example of the _ placeholder where inference needs it - Mention directories for rue test in the CLI page - Format the security examples like rue fmt
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
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.
Rewrites the docs to cover everything in Rue 0.12.0. Every claim was checked against the 0.12.0 compiler source and CLI, and every
ruecode block compiles with 0.12.0, except fragments, multi-file examples, and blocks that deliberately show an error.Changes
Rue.toml, how the CLI finds a project, andbuild --allRue.toml, flags, attributes,expect, inner attributes, naming, and the full list of lints.hexfiles, lambdas, function typesconst { }blockselse if, and the rules forifstatements andreturn>>>, BLS scalar multiplication, precedencesuperrules, re-exportslength, list types, spread struct fields, recursive type rules, narrowing, and what guards can't checkunchecked_cast,INFINITY_G1/G2,coinid#[...]attributes.Decisions to confirm
rue test <file>: the docs say it runs every test in the project the file belongs to, because that's what the 0.12.0 CLI does. The Rue README says only that file's tests run. If that's what the CLI is meant to do, the fix belongs in the CLI, and these docs should change with it.Note
Low Risk
Only documentation and site configuration change. CI's prettier, typecheck and build steps (which fail on broken links) all pass. The worst case is an inaccurate statement in the docs, and two review rounds checked the claims against the 0.12.0 compiler.