Repository navigation
docs: describe 0.19.0 in the README and move version examples to 0.19 - #563
Merged
Merged
Conversation
The Install note said `htl rs`, `teal_types!`, the `[rust]` table of `htl.toml` and `htl::run` were on main and not in a release. They are in 0.19.0, so the note now says they are in 0.19.0 and later, and that on 0.18 `htl rs` is an unknown subcommand and an `htl.toml` with a `[rust]` table does not parse. The "not yet in a release" lines go: the one at the top of the Calling Teal section, and the one in the `[rust]` sample of `htl.toml`, which now says "0.19 and later". Version examples move from 0.18 to 0.19 in the README (the `mise use` pins, the `htl` dependency, the `[toolchain]` sample, the `htl resolve` output) and in the doc samples of `htl::config` and `htl::resolve`.
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.
What changed
The README on
mainstill says thathtl rs,teal_types!, the[rust]table ofhtl.tomlandhtl::runare onmainand not yet in a release. They shipped in 0.19.0. This PR updates the wording:htl rsis an unknown subcommand, and anhtl.tomlwith a[rust]table does not parse.[rust]sample ofhtl.toml, which now says "0.19 and later".mise usepins, thehtldependency, the[toolchain]sample and thehtl resolveoutput. The doc samples ofhtl::configandhtl::resolvechange the same way.This commit was meant to ride on the release PR (#562), but #562 merged before the commit was pushed to its branch, so it comes here as a separate PR. The other option was to wait for the next release PR to carry it. That was not taken because the README on
mainwould keep calling released features unreleased until then.Acceptance
No issue. The criterion is that the README and doc samples no longer describe 0.19.0 features as unreleased or use 0.18 in version examples.
git grep -n "not yet in a release"on README.md, config.rs and resolve.rs prints nothingmain, printsREADME.md:74:(the Install note) andREADME.md:246:(the top of the Calling Teal section)git grep -n "0\.18"on the same files prints only the Install note's line about 0.18README.md:75:…are in 0.19.0 and later; on 0.18, `htl rs` is an unknownmain, also prints themise use, dependency,[toolchain]andhtl resolveexamplesChecks
just pre-commit(fmt, tests, clippy): not run. The Rust changes are text inside atomlfence and a plain-text fence in module doc comments, which rustdoc does not compile.just pre-push(full build, end-to-end cases): not run, for the same reason.htl::configandhtl::resolve.Not covered
Two stale pointers found earlier are left for another PR. The scaffold output points at a README "Build targets" section that does not exist, and the test prelude points at a README "Tests" section. No issue has been filed for them yet.
Refs #562