From 429eb988b900170b841b3e87e4791d74018195db Mon Sep 17 00:00:00 2001 From: Joe Mooring Date: Sat, 17 Feb 2024 12:29:38 -0800 Subject: [PATCH] Change "canonical" to "logical" when describing Page.Path --- content/en/methods/page/Path.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/methods/page/Path.md b/content/en/methods/page/Path.md index e09e771a97d..b3cdfd42b50 100644 --- a/content/en/methods/page/Path.md +++ b/content/en/methods/page/Path.md @@ -1,6 +1,6 @@ --- title: Path -description: Returns the canonical page path of the given page. +description: Returns the logical path of the given page. categories: [] keywords: [] action: @@ -13,16 +13,16 @@ action: {{< new-in 0.123.0 >}} -The `Path` method on a `Page` object returns the canonical page path of the given page, regardless of whether the page is backed by a file. +The `Path` method on a `Page` object returns the logical path of the given page, regardless of whether the page is backed by a file. ```go-html-template {{ .Path }} → /posts/post-1 ``` -This value is neither a file path nor a relative URL. It is a canonical identifier for each page, independent of content format, language, and URL. +This value is neither a file path nor a relative URL. It is a logical identifier for each page, independent of content format, language, and URL. {{% note %}} -Beginning with the release of [v0.92.0] in January 2022, Hugo emitted a warning whenever the `Path` method was called. The warning indicated that this method would change in a future release. +Beginning with the release of [v0.92.0] in January 2022, Hugo emitted a warning whenever calling the `Path` method. The warning indicated that this method would change in a future release. The meaning of, and value returned by, the `Path` method on a `Page` object changed with the release of [v0.123.0] in February 2024. @@ -30,7 +30,7 @@ The meaning of, and value returned by, the `Path` method on a `Page` object chan [v0.123.0]: https://github.com/gohugoio/hugo/releases/tag/v0.123.0 {{% /note %}} -To determine the canonical page path for pages backed by a file, Hugo starts with the file path, relative to the content directory, and then: +To determine the logical path for pages backed by a file, Hugo starts with the file path, relative to the content directory, and then: 1. Strips the file extension 2. Strips the language identifier