From 52bc9612eab089e782d74641d8a16fc1ebfe6002 Mon Sep 17 00:00:00 2001 From: Daniel Chao Date: Wed, 7 Feb 2024 19:40:43 -0800 Subject: [PATCH] Reword verbage to "pantry" (#64) * Reword verbage to "pantry" * Fix verbage --- .../language-tutorial/pages/03_writing_a_template.adoc | 2 +- pkl-doc/src/main/kotlin/org/pkl/doc/ClassPageGenerator.kt | 2 +- pkl-doc/src/main/kotlin/org/pkl/doc/ModulePageGenerator.kt | 2 +- pkl-doc/src/main/kotlin/org/pkl/doc/PackagePageGenerator.kt | 2 +- .../src/test/kotlin/org/pkl/executor/EmbeddedExecutorTest.kt | 4 ++-- stdlib/DocPackageInfo.pkl | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/modules/language-tutorial/pages/03_writing_a_template.adoc b/docs/modules/language-tutorial/pages/03_writing_a_template.adoc index 64341b4c..023b2714 100644 --- a/docs/modules/language-tutorial/pages/03_writing_a_template.adoc +++ b/docs/modules/language-tutorial/pages/03_writing_a_template.adoc @@ -256,7 +256,7 @@ By "precisely" we mean, that amending an object also can't "turn it into" an ins == A new template Now that you know about types, you can start writing your first template. -So far, you've written configurations with Pkl, either without a template, or using a template on Pkl Hub. +So far, you've written configurations with Pkl, either without a template, or using the `acmecicd` template from xref:02_filling_out_a_template.adoc#amending-templates[Amending templates]. It is often easiest to first write a (typical) configuration for which you want to create a template. Suppose you want to define what a live workshop for this tutorial looks like. Consider this example: diff --git a/pkl-doc/src/main/kotlin/org/pkl/doc/ClassPageGenerator.kt b/pkl-doc/src/main/kotlin/org/pkl/doc/ClassPageGenerator.kt index 2985d3a7..5c7e68b6 100644 --- a/pkl-doc/src/main/kotlin/org/pkl/doc/ClassPageGenerator.kt +++ b/pkl-doc/src/main/kotlin/org/pkl/doc/ClassPageGenerator.kt @@ -116,7 +116,7 @@ internal class ClassPageGenerator( } // example output: - // class HostAlias (io.k8s/api/core/v1/PodSpec:befa7c51) • Pkl Hub + // HostAlias (pkg.pkl-lang.org/pkl-k8s/k8s@1.0.0) • Package Docs override fun HTMLTag.renderPageTitle() { val classScope = pageScope val moduleScope = classScope.parent!! diff --git a/pkl-doc/src/main/kotlin/org/pkl/doc/ModulePageGenerator.kt b/pkl-doc/src/main/kotlin/org/pkl/doc/ModulePageGenerator.kt index b99f2bb2..b77a338a 100644 --- a/pkl-doc/src/main/kotlin/org/pkl/doc/ModulePageGenerator.kt +++ b/pkl-doc/src/main/kotlin/org/pkl/doc/ModulePageGenerator.kt @@ -105,7 +105,7 @@ internal class ModulePageGenerator( } // example output: - // module PodSpec (io.k8s/api/core/v1:befa7c51) • Pkl Hub + // module PodSpec (pkg.pkl-lang.org/pkl-k8s/k8s:1.0.0) • Package Docs override fun HTMLTag.renderPageTitle() { val moduleScope = pageScope val packageScope = moduleScope.parent!! diff --git a/pkl-doc/src/main/kotlin/org/pkl/doc/PackagePageGenerator.kt b/pkl-doc/src/main/kotlin/org/pkl/doc/PackagePageGenerator.kt index 2c78a749..8969c26b 100644 --- a/pkl-doc/src/main/kotlin/org/pkl/doc/PackagePageGenerator.kt +++ b/pkl-doc/src/main/kotlin/org/pkl/doc/PackagePageGenerator.kt @@ -86,7 +86,7 @@ internal class PackagePageGenerator( } // example output: - // package io.k8s (befa7c51) • Pkl Hub + // package pkg.pkl-lang.org/pkl-k8s/k8s (1.0.0) • Package Docs override fun HTMLTag.renderPageTitle() { +pageScope.name +" (" diff --git a/pkl-executor/src/test/kotlin/org/pkl/executor/EmbeddedExecutorTest.kt b/pkl-executor/src/test/kotlin/org/pkl/executor/EmbeddedExecutorTest.kt index 25c84097..c9495631 100644 --- a/pkl-executor/src/test/kotlin/org/pkl/executor/EmbeddedExecutorTest.kt +++ b/pkl-executor/src/test/kotlin/org/pkl/executor/EmbeddedExecutorTest.kt @@ -367,8 +367,8 @@ class EmbeddedExecutorTest { .contains("Evaluation timed out after 1 second(s).") } - // As of 0.16, only Pkl Hub modules are cached. - // Because this test doesn't import a Pkl Hub module, it doesn't really test + // Only packages are cached. + // Because this test doesn't import a package, it doesn't really test // that the `moduleCacheDir` option takes effect. @Test fun `evaluate a module with enabled module cache`(@TempDir tempDir: Path) { diff --git a/stdlib/DocPackageInfo.pkl b/stdlib/DocPackageInfo.pkl index 6945811d..8d7add27 100644 --- a/stdlib/DocPackageInfo.pkl +++ b/stdlib/DocPackageInfo.pkl @@ -143,7 +143,7 @@ issueTracker: Uri /// The packages depended on by this package. /// /// Used to display package dependencies and to create documentation links. -/// Set automatically for Pkl Hub packages. +/// Set automatically for packages that are part of a docsite. dependencies: Listing(isDistinctBy((it) -> it.name)) /// Any extra attributes to add to the documentation.