From 03eed305f9c676441ddd8069ad13200a52311817 Mon Sep 17 00:00:00 2001 From: John Kerl Date: Sun, 10 Sep 2023 17:23:50 -0400 Subject: [PATCH] doc tweaks --- docs/src/miller-as-library.md | 5 +++++ docs/src/miller-as-library.md.in | 5 +++++ docs/src/release-docs.md | 1 + docs/src/release-docs.md.in | 1 + 4 files changed, 12 insertions(+) diff --git a/docs/src/miller-as-library.md b/docs/src/miller-as-library.md index 49c381138a..cf21491659 100644 --- a/docs/src/miller-as-library.md +++ b/docs/src/miller-as-library.md @@ -19,6 +19,11 @@ Quick links: Very initially and experimentally, as of Miller 6.9.1, Go developers will be able to access Miller source code --- moved from `internal/pkg/` to `pkg/` --- within their own Go projects. +Caveat emptor: Miller's backward-compatibility guarantees are at the CLI level; API is not guaranteed stable. +For this reason, please be careful with your version pins. + +I'm happy to discuss this new area further at the [discussions page](https://github.com/johnkerl/miller/discussions). + ## Setup ``` diff --git a/docs/src/miller-as-library.md.in b/docs/src/miller-as-library.md.in index b7051165bc..f5bda1b005 100644 --- a/docs/src/miller-as-library.md.in +++ b/docs/src/miller-as-library.md.in @@ -3,6 +3,11 @@ Very initially and experimentally, as of Miller 6.9.1, Go developers will be able to access Miller source code --- moved from `internal/pkg/` to `pkg/` --- within their own Go projects. +Caveat emptor: Miller's backward-compatibility guarantees are at the CLI level; API is not guaranteed stable. +For this reason, please be careful with your version pins. + +I'm happy to discuss this new area further at the [discussions page](https://github.com/johnkerl/miller/discussions). + ## Setup ``` diff --git a/docs/src/release-docs.md b/docs/src/release-docs.md index 868e253375..4b9380d720 100644 --- a/docs/src/release-docs.md +++ b/docs/src/release-docs.md @@ -23,6 +23,7 @@ If your `mlr version` says something like `Miller v5.10.2` or `mlr 6.0.0`, witho | Release | Docs | Release notes | |---------|---------------------------------------------------------------------|---------------| +main | [main branch](https://miller.readthedocs.io/en/main) | N/A | 6.8.0 | [Miller 6.8.0](https://miller.readthedocs.io/en/6.8.0) | [New case verb, index DSL function, and more](https://github.com/johnkerl/miller/releases/tag/v6.8.0) | 6.7.0 | [Miller 6.7.0](https://miller.readthedocs.io/en/6.7.0) | [New leftpad/rightpad DSL functions, unspace verb, and more](https://github.com/johnkerl/miller/releases/tag/v6.7.0) | 6.6.0 | [Miller 6.6.0](https://miller.readthedocs.io/en/6.6.0) | [Bugfixes and unspace verb](https://github.com/johnkerl/miller/releases/tag/v6.6.0) | diff --git a/docs/src/release-docs.md.in b/docs/src/release-docs.md.in index b98058192d..41bd540253 100644 --- a/docs/src/release-docs.md.in +++ b/docs/src/release-docs.md.in @@ -7,6 +7,7 @@ If your `mlr version` says something like `Miller v5.10.2` or `mlr 6.0.0`, witho | Release | Docs | Release notes | |---------|---------------------------------------------------------------------|---------------| +main | [main branch](https://miller.readthedocs.io/en/main) | N/A | 6.8.0 | [Miller 6.8.0](https://miller.readthedocs.io/en/6.8.0) | [New case verb, index DSL function, and more](https://github.com/johnkerl/miller/releases/tag/v6.8.0) | 6.7.0 | [Miller 6.7.0](https://miller.readthedocs.io/en/6.7.0) | [New leftpad/rightpad DSL functions, unspace verb, and more](https://github.com/johnkerl/miller/releases/tag/v6.7.0) | 6.6.0 | [Miller 6.6.0](https://miller.readthedocs.io/en/6.6.0) | [Bugfixes and unspace verb](https://github.com/johnkerl/miller/releases/tag/v6.6.0) |