Correct typos in Go comments

This commit is contained in:
Oleksandr Redko 2023-02-18 22:47:35 +02:00 committed by Bjørn Erik Pedersen
parent 17e60b77e1
commit 36ce3a4a9d
26 changed files with 35 additions and 35 deletions

View file

@ -248,7 +248,7 @@ func (c *Cache) GetBytes(id string) (ItemInfo, []byte, error) {
return info, nil, nil return info, nil, nil
} }
// Get gets the file with the given id from the cahce, nil if none found. // Get gets the file with the given id from the cache, nil if none found.
func (c *Cache) Get(id string) (ItemInfo, io.ReadCloser, error) { func (c *Cache) Get(id string) (ItemInfo, io.ReadCloser, error) {
id = cleanID(id) id = cleanID(id)

View file

@ -229,7 +229,7 @@ func TestFlags(t *testing.T) {
if cmd.getCommand() == nil { if cmd.getCommand() == nil {
continue continue
} }
// We are only intereseted in the flag handling here. // We are only interested in the flag handling here.
cmd.getCommand().RunE = noOpRunE cmd.getCommand().RunE = noOpRunE
} }
rootCmd := root.getCommand() rootCmd := root.getCommand()

View file

@ -505,7 +505,7 @@ func removeErrorPrefixFromLog(content string) string {
} }
var logReplacer = strings.NewReplacer( var logReplacer = strings.NewReplacer(
"can't", "cant", // Chroma lexer does'nt do well with "can't" "can't", "cant", // Chroma lexer doesn't do well with "can't"
"*hugolib.pageState", "page.Page", // Page is the public interface. "*hugolib.pageState", "page.Page", // Page is the public interface.
"Rebuild failed:", "", "Rebuild failed:", "",
) )
@ -547,7 +547,7 @@ func (c *commandeer) serve(s *serverCmd) error {
roots = []string{""} roots = []string{""}
} }
// Cache it here. The HugoSites object may be unavaialble later on due to intermitent configuration errors. // Cache it here. The HugoSites object may be unavailable later on due to intermittent configuration errors.
// To allow the en user to change the error template while the server is running, we use // To allow the en user to change the error template while the server is running, we use
// the freshest template we can provide. // the freshest template we can provide.
var ( var (

View file

@ -211,7 +211,7 @@ func TestServerBugs(t *testing.T) {
c.Assert(r.err, qt.IsNil) c.Assert(r.err, qt.IsNil)
c.Assert(r.homesContent[0], qt.Contains, "PostProcess: /foo.min.css") c.Assert(r.homesContent[0], qt.Contains, "PostProcess: /foo.min.css")
}}, }},
// Isue 9901 // Issue 9901
{"Multihost", ` {"Multihost", `
defaultContentLanguage = 'en' defaultContentLanguage = 'en'
[languages] [languages]

View file

@ -27,7 +27,7 @@ type Workers struct {
// Runner wraps the lifecycle methods of a new task set. // Runner wraps the lifecycle methods of a new task set.
// //
// Run wil block until a worker is available or the context is cancelled, // Run will block until a worker is available or the context is cancelled,
// and then run the given func in a new goroutine. // and then run the given func in a new goroutine.
// Wait will wait for all the running goroutines to finish. // Wait will wait for all the running goroutines to finish.
type Runner interface { type Runner interface {

View file

@ -44,7 +44,7 @@ func (w Whitelist) MarshalJSON() ([]byte, error) {
// NewWhitelist creates a new Whitelist from zero or more patterns. // NewWhitelist creates a new Whitelist from zero or more patterns.
// An empty patterns list or a pattern with the value 'none' will create // An empty patterns list or a pattern with the value 'none' will create
// a whitelist that will Accept noone. // a whitelist that will Accept none.
func NewWhitelist(patterns ...string) Whitelist { func NewWhitelist(patterns ...string) Whitelist {
if len(patterns) == 0 { if len(patterns) == 0 {
return Whitelist{acceptNone: true} return Whitelist{acceptNone: true}

View file

@ -42,7 +42,7 @@ func NewPathSpec(fs *hugofs.Fs, cfg config.Provider, logger loggers.Logger) (*Pa
return NewPathSpecWithBaseBaseFsProvided(fs, cfg, logger, nil) return NewPathSpecWithBaseBaseFsProvided(fs, cfg, logger, nil)
} }
// NewPathSpecWithBaseBaseFsProvided creats a new PathSpec from the given filesystems and language. // NewPathSpecWithBaseBaseFsProvided creates a new PathSpec from the given filesystems and language.
// If an existing BaseFs is provided, parts of that is reused. // If an existing BaseFs is provided, parts of that is reused.
func NewPathSpecWithBaseBaseFsProvided(fs *hugofs.Fs, cfg config.Provider, logger loggers.Logger, baseBaseFs *filesystems.BaseFs) (*PathSpec, error) { func NewPathSpecWithBaseBaseFsProvided(fs *hugofs.Fs, cfg config.Provider, logger loggers.Logger, baseBaseFs *filesystems.BaseFs) (*PathSpec, error) {
p, err := paths.New(fs, cfg) p, err := paths.New(fs, cfg)

View file

@ -82,7 +82,7 @@ func (gc *globCache) GetGlob(pattern string) (glob.Glob, error) {
type globDecorator struct { type globDecorator struct {
// On Windows we may get filenames with Windows slashes to match, // On Windows we may get filenames with Windows slashes to match,
// which wee need to normalize. // which we need to normalize.
isWindows bool isWindows bool
g glob.Glob g glob.Glob

View file

@ -43,7 +43,7 @@ import (
// //
// For bundled pages (/mybundle/index.md), we use the folder name. // For bundled pages (/mybundle/index.md), we use the folder name.
// //
// An exmple of a full page key would be "/blog/__hb_page1__hl_" // An example of a full page key would be "/blog/__hb_page1__hl_"
// //
// Bundled resources are stored in the `resources` having their path prefixed // Bundled resources are stored in the `resources` having their path prefixed
// with the bundle they belong to, e.g. // with the bundle they belong to, e.g.
@ -317,7 +317,7 @@ type contentMap struct {
// There are currently two cases where this is used: // There are currently two cases where this is used:
// 1. Short name lookups in ref/relRef, e.g. using only "mypage.md" without a path. // 1. Short name lookups in ref/relRef, e.g. using only "mypage.md" without a path.
// 2. Links resolved from a remounted content directory. These are restricted to the same module. // 2. Links resolved from a remounted content directory. These are restricted to the same module.
// Both of the above cases can result in ambigous lookup errors. // Both of the above cases can result in ambiguous lookup errors.
pageReverseIndex *contentTreeReverseIndex pageReverseIndex *contentTreeReverseIndex
// Section nodes. // Section nodes.

View file

@ -297,7 +297,7 @@ func (s SourceFilesystems) StaticFs(lang string) afero.Fs {
// StatResource looks for a resource in these filesystems in order: static, assets and finally content. // StatResource looks for a resource in these filesystems in order: static, assets and finally content.
// If found in any of them, it returns FileInfo and the relevant filesystem. // If found in any of them, it returns FileInfo and the relevant filesystem.
// Any non herrors.IsNotExist error will be returned. // Any non herrors.IsNotExist error will be returned.
// An herrors.IsNotExist error wil be returned only if all filesystems return such an error. // An herrors.IsNotExist error will be returned only if all filesystems return such an error.
// Note that if we only wanted to find the file, we could create a composite Afero fs, // Note that if we only wanted to find the file, we could create a composite Afero fs,
// but we also need to know which filesystem root it lives in. // but we also need to know which filesystem root it lives in.
func (s SourceFilesystems) StatResource(lang, filename string) (fi os.FileInfo, fs afero.Fs, err error) { func (s SourceFilesystems) StatResource(lang, filename string) (fi os.FileInfo, fs afero.Fs, err error) {

View file

@ -723,7 +723,7 @@ type BuildCfg struct {
// shouldRender is used in the Fast Render Mode to determine if we need to re-render // shouldRender is used in the Fast Render Mode to determine if we need to re-render
// a Page: If it is recently visited (the home pages will always be in this set) or changed. // a Page: If it is recently visited (the home pages will always be in this set) or changed.
// Note that a page does not have to have a content page / file. // Note that a page does not have to have a content page / file.
// For regular builds, this will allways return true. // For regular builds, this will always return true.
// TODO(bep) rename/work this. // TODO(bep) rename/work this.
func (cfg *BuildCfg) shouldRender(p *pageState) bool { func (cfg *BuildCfg) shouldRender(p *pageState) bool {
if p == nil { if p == nil {

View file

@ -209,7 +209,7 @@ func (c *PageCollections) getSectionOrPage(ref string) (*contentNode, string) {
return m.getPage(s, name), name return m.getPage(s, name), name
} }
// For Ref/Reflink and .Site.GetPage do simple name lookups for the potentially ambigous myarticle.md and /myarticle.md, // For Ref/Reflink and .Site.GetPage do simple name lookups for the potentially ambiguous myarticle.md and /myarticle.md,
// but not when we get ./myarticle*, section/myarticle. // but not when we get ./myarticle*, section/myarticle.
func shouldDoSimpleLookup(ref string) bool { func shouldDoSimpleLookup(ref string) bool {
if ref[0] == '.' { if ref[0] == '.' {
@ -325,7 +325,7 @@ func (c *PageCollections) getContentNode(context page.Page, isReflink bool, ref
return nil, nil return nil, nil
} }
// Ref/relref supports this potentially ambigous lookup. // Ref/relref supports this potentially ambiguous lookup.
return getByName(path.Base(name)) return getByName(path.Base(name))
} }

View file

@ -428,7 +428,7 @@ func newSite(cfg deps.DepsCfg) (*Site, error) {
delete(disabledKinds, "taxonomyTerm") delete(disabledKinds, "taxonomyTerm")
} else if disabledKinds[page.KindTaxonomy] && !disabledKinds[page.KindTerm] { } else if disabledKinds[page.KindTaxonomy] && !disabledKinds[page.KindTerm] {
// This is a potentially ambigous situation. It may be correct. // This is a potentially ambiguous situation. It may be correct.
ignorableLogger.Errorsf(constants.ErrIDAmbigousDisableKindTaxonomy, `You have the value 'taxonomy' in the disabledKinds list. In Hugo 0.73.0 we fixed these to be what most people expect (taxonomy and term). ignorableLogger.Errorsf(constants.ErrIDAmbigousDisableKindTaxonomy, `You have the value 'taxonomy' in the disabledKinds list. In Hugo 0.73.0 we fixed these to be what most people expect (taxonomy and term).
But this also means that your site configuration may not do what you expect. If it is correct, you can suppress this message by following the instructions below.`) But this also means that your site configuration may not do what you expect. If it is correct, you can suppress this message by following the instructions below.`)
} }
@ -487,7 +487,7 @@ But this also means that your site configuration may not do what you expect. If
siteOutputs[page.KindTerm] = v2 siteOutputs[page.KindTerm] = v2
delete(siteOutputs, "taxonomyTerm") delete(siteOutputs, "taxonomyTerm")
} else if hasTaxonomy && !hasTerm { } else if hasTaxonomy && !hasTerm {
// This is a potentially ambigous situation. It may be correct. // This is a potentially ambiguous situation. It may be correct.
ignorableLogger.Errorsf(constants.ErrIDAmbigousOutputKindTaxonomy, `You have configured output formats for 'taxonomy' in your site configuration. In Hugo 0.73.0 we fixed these to be what most people expect (taxonomy and term). ignorableLogger.Errorsf(constants.ErrIDAmbigousOutputKindTaxonomy, `You have configured output formats for 'taxonomy' in your site configuration. In Hugo 0.73.0 we fixed these to be what most people expect (taxonomy and term).
But this also means that your site configuration may not do what you expect. If it is correct, you can suppress this message by following the instructions below.`) But this also means that your site configuration may not do what you expect. If it is correct, you can suppress this message by following the instructions below.`)
} }

View file

@ -92,7 +92,7 @@ type Language struct {
collator *Collator collator *Collator
location *time.Location location *time.Location
// Error during initialization. Will fail the buld. // Error during initialization. Will fail the build.
initErr error initErr error
} }
@ -223,7 +223,7 @@ func (l Languages) AsOrdinalSet() map[string]int {
} }
// IsMultihost returns whether there are more than one language and at least one of // IsMultihost returns whether there are more than one language and at least one of
// the languages has baseURL specificed on the language level. // the languages has baseURL specified on the language level.
func (l Languages) IsMultihost() bool { func (l Languages) IsMultihost() bool {
if len(l) <= 1 { if len(l) <= 1 {
return false return false
@ -326,7 +326,7 @@ type Collator struct {
// CompareStrings compares a and b. // CompareStrings compares a and b.
// It returns -1 if a < b, 1 if a > b and 0 if a == b. // It returns -1 if a < b, 1 if a > b and 0 if a == b.
// Note that the Collator is not thread safe, so you may want // Note that the Collator is not thread safe, so you may want
// to aquire a lock on it before calling this method. // to acquire a lock on it before calling this method.
func (c *Collator) CompareStrings(a, b string) int { func (c *Collator) CompareStrings(a, b string) int {
return c.c.CompareString(a, b) return c.c.CompareString(a, b)
} }

View file

@ -112,7 +112,7 @@ func (ids *idFactory) Generate(value []byte, kind ast.NodeKind) []byte {
} }
if _, found := ids.vals[util.BytesToReadOnlyString(buf.Bytes())]; found { if _, found := ids.vals[util.BytesToReadOnlyString(buf.Bytes())]; found {
// Append a hypen and a number, starting with 1. // Append a hyphen and a number, starting with 1.
buf.WriteRune('-') buf.WriteRune('-')
pos := buf.Len() pos := buf.Len()
for i := 1; ; i++ { for i := 1; ; i++ {

View file

@ -200,8 +200,8 @@ func RenderASTAttributes(w hugio.FlexiWriter, attributes ...ast.Attribute) {
} }
// Render writes the attributes to the given as attributes to an HTML element. // Render writes the attributes to the given as attributes to an HTML element.
// This is used for the default codeblock renderering. // This is used for the default codeblock rendering.
// This performs HTML esacaping of string attributes. // This performs HTML escaping of string attributes.
func RenderAttributes(w hugio.FlexiWriter, skipClass bool, attributes ...Attribute) { func RenderAttributes(w hugio.FlexiWriter, skipClass bool, attributes ...Attribute) {
for _, attr := range attributes { for _, attr := range attributes {
a := strings.ToLower(string(attr.Name)) a := strings.ToLower(string(attr.Name))

View file

@ -11,7 +11,7 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
// Package media containes Media Type (MIME type) related types and functions. // Package media contains Media Type (MIME type) related types and functions.
package media package media
import ( import (

View file

@ -23,7 +23,7 @@ import (
type Format string type Format string
const ( const (
// These are the supported metdata formats in Hugo. Most of these are also // These are the supported metadata formats in Hugo. Most of these are also
// supported as /data formats. // supported as /data formats.
ORG Format = "org" ORG Format = "org"
JSON Format = "json" JSON Format = "json"

View file

@ -23,7 +23,7 @@ const (
KindHome = "home" KindHome = "home"
KindSection = "section" KindSection = "section"
// Note tha before Hugo 0.73 these were confusingly named // Note that before Hugo 0.73 these were confusingly named
// taxonomy (now: term) // taxonomy (now: term)
// taxonomyTerm (now: taxonomy) // taxonomyTerm (now: taxonomy)
KindTaxonomy = "taxonomy" KindTaxonomy = "taxonomy"

View file

@ -22,7 +22,7 @@ func (p Pages) Next(cur Page) Page {
return p[x-1] return p[x-1]
} }
// Prev returns the previous page reletive to the given // Prev returns the previous page relative to the given
func (p Pages) Prev(cur Page) Page { func (p Pages) Prev(cur Page) Page {
x := searchPage(cur, p) x := searchPage(cur, p)

View file

@ -62,7 +62,7 @@ type Site interface {
// Returns the BaseURL for this Site. // Returns the BaseURL for this Site.
BaseURL() template.URL BaseURL() template.URL
// Retuns a taxonomy map. // Returns a taxonomy map.
Taxonomies() TaxonomyList Taxonomies() TaxonomyList
// Returns the last modification date of the content. // Returns the last modification date of the content.

View file

@ -164,7 +164,7 @@ func resolveComponentInAssets(fs afero.Fs, impPath string) *hugofs.FileMeta {
var m *hugofs.FileMeta var m *hugofs.FileMeta
// We need to check if this is a regular file imported without an extension. // We need to check if this is a regular file imported without an extension.
// There may be ambigous situations where both foo.js and foo/index.js exists. // There may be ambiguous situations where both foo.js and foo/index.js exists.
// This import order is in line with both how Node and ESBuild's native // This import order is in line with both how Node and ESBuild's native
// import resolver works. // import resolver works.

View file

@ -301,7 +301,7 @@ func NewGitInfo(info gitmap.GitInfo) GitInfo {
return GitInfo(info) return GitInfo(info)
} }
// GitInfo provides information about a version controled source file. // GitInfo provides information about a version controlled source file.
type GitInfo struct { type GitInfo struct {
// Commit hash. // Commit hash.
Hash string `json:"hash"` Hash string `json:"hash"`

View file

@ -34,7 +34,7 @@ type Filesystem struct {
SourceSpec SourceSpec
} }
// NewFilesystem returns a new filesytem for a given source spec. // NewFilesystem returns a new filesystem for a given source spec.
func (sp SourceSpec) NewFilesystem(base string) *Filesystem { func (sp SourceSpec) NewFilesystem(base string) *Filesystem {
return &Filesystem{SourceSpec: sp, Base: base} return &Filesystem{SourceSpec: sp, Base: base}
} }

View file

@ -72,7 +72,7 @@ const (
HasLockContextKey = hasLockContextKeyType("hasLock") HasLockContextKey = hasLockContextKeyType("hasLock")
) )
// Note: The context is currently not fully implemeted in Hugo. This is a work in progress. // Note: The context is currently not fully implemented in Hugo. This is a work in progress.
func (t *executer) ExecuteWithContext(ctx context.Context, p Preparer, wr io.Writer, data any) error { func (t *executer) ExecuteWithContext(ctx context.Context, p Preparer, wr io.Writer, data any) error {
if ctx == nil { if ctx == nil {
panic("nil context") panic("nil context")
@ -123,7 +123,7 @@ func (t *Template) executeWithState(state *state, value reflect.Value) (err erro
// can execute in parallel. // can execute in parallel.
type state struct { type state struct {
tmpl *Template tmpl *Template
ctx context.Context // Added for Hugo. The orignal data context. ctx context.Context // Added for Hugo. The original data context.
prep Preparer // Added for Hugo. prep Preparer // Added for Hugo.
helper ExecHelper // Added for Hugo. helper ExecHelper // Added for Hugo.
wr io.Writer wr io.Writer

View file

@ -774,8 +774,8 @@ func (t *templateHandler) loadEmbedded() error {
name := strings.TrimPrefix(filepath.ToSlash(path), "embedded/templates/") name := strings.TrimPrefix(filepath.ToSlash(path), "embedded/templates/")
templateName := name templateName := name
// For the render hooks and the server templates it does not make sense to preseve the // For the render hooks and the server templates it does not make sense to preserve the
// double _indternal double book-keeping, // double _internal double book-keeping,
// just add it if its now provided by the user. // just add it if its now provided by the user.
if !strings.Contains(path, "_default/_markup") && !strings.HasPrefix(name, "_server/") { if !strings.Contains(path, "_default/_markup") && !strings.HasPrefix(name, "_server/") {
templateName = internalPathPrefix + name templateName = internalPathPrefix + name