Repository navigation
Conversation
Markdown pages from the official renderer (linked in like the official generators), or the documentation model as JSON. `--version` documents a built version from its frozen IR and `//!` headers, `--changelog-from` adds a changelog, and comline.toml's `[doc]` table sets the defaults: `out`, `format`, `renderer` (an external renderer, run like an external generator through the same sandbox, limits and path checks), `timeout`, `links` and `changelog_from`. Pins core 076cae0, generation 7b51264, comline-rust bef9a74 and comline-typescript 47b54cc. Generated code is unchanged.
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.
Part of ComlineProject/core#145, step 5 of the autodoc cascade.
comline docdoc::modelon the compiled package);--versiondocuments a built version from its frozen IR and the//!headers core now freezes (doc::model_frozen+doc::read_docs, core#152). A built version has no source, so no wire summary.--changelog-from <v>addsdoc::changelogfrom that built version to the documented one.--format jsonwritesmodel.json; any other format is a renderer id.markdownis the official renderer (comline-doc-markdown), linked in and answered in process through the protocol (external::builtin_render), as the built-in generators are..comline/.comline generate --watchexists).[doc]in comline.tomlShared types from
comline_codegen::config(generation#95), so the JSON Schema and the LS get it:out(defaultdocs/api),format(defaultmarkdown),renderer,timeout,links(dependency → base URL),changelog_from. Each flag overrides its key.renderer = "<path>"runs through the sameexternal::Externalas an external generator: wasmtime sandbox, limits, path checks. It's asked toDescribefirst and refused, before anything is sent, unless it lists the format inrenderersat the CLI's model version.Pins
core
076cae0, generation7b51264(+comline-doc-markdownat the same rev), comline-rustbef9a74, comline-typescript47b54cc. The test-generator fixture workspace moves to the same revs and gains arendererbinary.Tests
tests/cli/doc.rs: working-tree pages, a built version documented with its frozen headers after the sources changed, a changelog,[doc]settings with--format json, an unknown format.tests/cli/external.rs: the Markdown renderer as an external.wasmand native program writes exactly what the built-in writes; a generator offering no renderer is refused.docs/cli.mddocuments the command and the table.Byte-identical generated code
comline generatewith themainbinary (76afd09) and this branch's, overchat_project,simple_projectandvalidated_project× {Rustcode+ TScodewithvalidate_on_decode = "collect", Rustlib, TSlibwithasync = true}: 39 files,sha256sumlists identical.Local CI:
cargo build,cargo test(117 CLI tests + unit),cargo fmt --check(both manifests), bothclippy -D warningsruns.