hugo

commit 097fd588ca2928056122991caaa879e835c5ba62
parent 41cc4e4ba3bd849cee7dcb691504ebebbfce680f
Author: Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Date:   Wed, 20 Apr 2022 17:08:01 +0200

Deprecate page.Author and page.Authors

These are not documented, and they don't belong on Page. We should consider having author a first class citizen of Hugo, but as it is not it's better modelled as a taxonomy.

Diffstat:
M
hugolib/page__meta.go
 | 
2
++
M
resources/page/page.go
 | 
3
+++

2 files changed, 5 insertions(+), 0 deletions(-)
diff --git a/hugolib/page__meta.go b/hugolib/page__meta.go
@@ -131,6 +131,7 @@ func (p *pageMeta) Aliases() []string {
 }
 
 func (p *pageMeta) Author() page.Author {
+	helpers.Deprecated(".Author", "Use taxonomies.", false)
 	authors := p.Authors()
 
 	for _, author := range authors {
@@ -140,6 +141,7 @@ func (p *pageMeta) Author() page.Author {
 }
 
 func (p *pageMeta) Authors() page.AuthorList {
+	helpers.Deprecated(".Authors", "Use taxonomies.", false)
 	authorKeys, ok := p.params["authors"]
 	if !ok {
 		return page.AuthorList{}
diff --git a/resources/page/page.go b/resources/page/page.go
@@ -52,7 +52,9 @@ type AlternativeOutputFormatsProvider interface {
 
 // AuthorProvider provides author information.
 type AuthorProvider interface {
+	// Deprecated.
 	Author() Author
+	// Deprecated.
 	Authors() AuthorList
 }
 
@@ -118,6 +120,7 @@ type InSectionPositioner interface {
 
 // InternalDependencies is considered an internal interface.
 type InternalDependencies interface {
+	// GetRelatedDocsHandler is for internal use only.
 	GetRelatedDocsHandler() *RelatedDocsHandler
 }