github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00
Code Issues Projects Releases Packages Wiki Activity

Deprecate page.Author and page.Authors

Browse source 
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.
This commit is contained in:
Bjørn Erik Pedersen 2022-04-20 17:08:01 +02:00
parent 41cc4e4ba3
commit 097fd588ca
2 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
hugolib/page__meta.go
View file

@ -131,6 +131,7 @@ func (p *pageMeta) Aliases() []string {
} }
func (p *pageMeta) Author() page.Author { func (p *pageMeta) Author() page.Author {
helpers.Deprecated(".Author", "Use taxonomies.", false)
authors := p.Authors() authors := p.Authors()
for _, author := range authors { for _, author := range authors {
@ -140,6 +141,7 @@ func (p *pageMeta) Author() page.Author {
} }
func (p *pageMeta) Authors() page.AuthorList { func (p *pageMeta) Authors() page.AuthorList {
helpers.Deprecated(".Authors", "Use taxonomies.", false)
authorKeys, ok := p.params["authors"] authorKeys, ok := p.params["authors"]
if !ok { if !ok {
return page.AuthorList{} return page.AuthorList{}

3
resources/page/page.go
View file

@ -52,7 +52,9 @@ type AlternativeOutputFormatsProvider interface {
// AuthorProvider provides author information. // AuthorProvider provides author information.
type AuthorProvider interface { type AuthorProvider interface {
// Deprecated.
Author() Author Author() Author
// Deprecated.
Authors() AuthorList Authors() AuthorList
} }
@ -118,6 +120,7 @@ type InSectionPositioner interface {
// InternalDependencies is considered an internal interface. // InternalDependencies is considered an internal interface.
type InternalDependencies interface { type InternalDependencies interface {
// GetRelatedDocsHandler is for internal use only.
GetRelatedDocsHandler() *RelatedDocsHandler GetRelatedDocsHandler() *RelatedDocsHandler
} }