diff options
| author | Oleksandr Redko <Oleksandr_Redko@epam.com> | 2023-05-18 12:05:56 +0300 |
|---|---|---|
| committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2023-05-18 21:25:27 +0200 |
| commit | 610cedaa61cf1f318ecd4a7818a896b1e56e7662 (patch) | |
| tree | 3c206f0386b05b44ec1f3bd00f9d96f6904c8446 /resources | |
| parent | 24e7d0c174a24a016f65be46765ab9c795e1e123 (diff) | |
all: Fix comments for exported functions and packages
Diffstat (limited to 'resources')
| -rw-r--r-- | resources/page/page.go | 4 | ||||
| -rw-r--r-- | resources/page/site.go | 6 | ||||
| -rw-r--r-- | resources/postpub/postpub.go | 2 | ||||
| -rw-r--r-- | resources/resource_transformers/tocss/dartsass/client.go | 2 |
4 files changed, 7 insertions, 7 deletions
diff --git a/resources/page/page.go b/resources/page/page.go index 1ec56e8cf..b1c867195 100644 --- a/resources/page/page.go +++ b/resources/page/page.go @@ -334,7 +334,7 @@ type PageWithoutContent interface { // Used in change/dependency tracking. identity.Provider - // Headings returns the headings for this page when a filter is set. + // HeadingsFiltered returns the headings for this page when a filter is set. // This is currently only triggered with the Related content feature // and the "fragments" type of index. HeadingsFiltered(context.Context) tableofcontents.Headings @@ -373,7 +373,7 @@ type RefProvider interface { // RelRef returns a relative URL to a page. RelRef(argsm map[string]any) (string, error) - // RefFrom is for internal use only. + // RelRefFrom is for internal use only. RelRefFrom(argsm map[string]any, source any) (string, error) } diff --git a/resources/page/site.go b/resources/page/site.go index aff7e86fe..16e070160 100644 --- a/resources/page/site.go +++ b/resources/page/site.go @@ -128,13 +128,13 @@ type Site interface { // For internal use only. GetPageWithTemplateInfo(info tpl.Info, ref ...string) (Page, error) - // BuildDraft is deprecated and will be removed in a future release. + // BuildDrafts is deprecated and will be removed in a future release. BuildDrafts() bool - // IsMultilingual reports whether this site is configured with more than one language. + // IsMultiLingual reports whether this site is configured with more than one language. IsMultiLingual() bool - // LanguagePrefi returns the language prefix for this site. + // LanguagePrefix returns the language prefix for this site. LanguagePrefix() string } diff --git a/resources/postpub/postpub.go b/resources/postpub/postpub.go index 5911362ec..93b5c2638 100644 --- a/resources/postpub/postpub.go +++ b/resources/postpub/postpub.go @@ -55,7 +55,7 @@ func NewPostPublishResource(id int, r resource.Resource) PostPublishedResource { } } -// postPublishResource holds a Resource to be transformed post publishing. +// PostPublishResource holds a Resource to be transformed post publishing. type PostPublishResource struct { prefix string delegate resource.Resource diff --git a/resources/resource_transformers/tocss/dartsass/client.go b/resources/resource_transformers/tocss/dartsass/client.go index f45e6537a..f358b93e5 100644 --- a/resources/resource_transformers/tocss/dartsass/client.go +++ b/resources/resource_transformers/tocss/dartsass/client.go @@ -11,7 +11,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -// Package godartsass integrates with the Dass Sass Embedded protocol to transpile +// Package dartsass integrates with the Dass Sass Embedded protocol to transpile // SCSS/SASS. package dartsass |