Remove the needsexamples construct

We need to rework the whole template func docs and, while a good idea, this does not fit into that.
This commit is contained in:
Bjørn Erik Pedersen 2017-07-16 15:13:35 +02:00
parent 4ac6e82810
commit 4e0bca2b1e
92 changed files with 2 additions and 121 deletions

View File

@ -14,5 +14,4 @@ aliases: []
relatedfuncs: []
toc: false
deprecated: false
needsexamples: true
---

View File

@ -360,22 +360,8 @@ This is a warning, which should be reserved for *important* information like bre
This is a warning, which should be reserved for *important* information like breaking changes.
{{% /warning %}}
## Ask for Code Examples
Sometimes you want to contribute to the docs but don't have enough time to provide lengthy examples. If you want to flag a piece of content as needing more examples, add the following field to your front matter:
```
needsexamples: true
```
## Places to Start
The preceding `needsexamples` field is used to generate the following list of flagged content. Links will take you directly to the edit URL for the file within the GitHub GUI in the event that you are not comfortable cloning and editing the repository locally.
{{< needsexamples >}}
{{% note "Pull Requests and Branches" %}}
Similar to [contributing to Hugo development](/contribute/development/), the Hugo team expects you to create a separate branch/fork when you make your generous contributions to the Hugo docs.
Similar to [contributing to Hugo development](/contribute/development/), the Hugo team expects you to create a separate branch/fork when you make your contributions to the Hugo docs.
{{% /note %}}
[abe]: https://en.wikipedia.org/wiki/Kobo_Abe

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [sections,lists,indexes]
ns:
signature: ["GetPage TYPE PATH"]
workson: []
hugoversion:

View File

@ -11,14 +11,12 @@ menu:
docs:
parent: "functions"
#tags: [multilingual,i18n,urls]
ns:
signature: ["absLangURL INPUT"]
workson: []
hugoversion:
relatedfuncs: [relLangURL]
deprecated: false
aliases: []
needsexamples: true
---
Both `absLangURL` and [`relLangURL`](/functions/rellangurl/) are similar to their [`absURL`](/functions/absurl/) and [`relURL`](/functions/relurl) relatives but will add the correct language prefix when the site is configured with more than one language.

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [urls]
ns:
signature: ["absURL INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [dates,time]
ns:
signature: ["AddDate YEARS MONTHS DAYS"]
workson: [times]
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [iteration]
ns:
signature: ["after INDEX COLLECTION"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [advanced]
ns:
signature: ["apply COLLETION FUNCTION [PARAM...]"]
workson: []
hugoversion:

View File

@ -12,7 +12,6 @@ menu:
parent: "functions"
#tags: []
relatedfuncs: []
ns:
signature: ["base64Decode INPUT", "base64Encode INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [trim]
ns:
signature: ["chomp INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [counting, word count]
ns:
signature: ["countrunes INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [counting, word count]
ns:
signature: ["countwords INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [dates,time,strings]
ns:
signature: ["dateFormat LAYOUT INPUT"]
workson: []
hugoversion:

View File

@ -13,7 +13,6 @@ menu:
docs:
parent: "functions"
toc:
ns:
signature: ["default DEFAULT INPUT"]
workson: []
hugoversion:

View File

@ -13,7 +13,6 @@ menu:
parent: "functions"
#tags: [iteration]
toc: false
ns:
signature: ["delimit COLLECTION DELIMIT LAST"]
workson: [lists,taxonomies,terms]
hugoversion:

View File

@ -12,14 +12,12 @@ menu:
docs:
parent: "functions"
#tags: [dictionary]
ns:
signature: ["dict KEY VALUE [KEY VALUE]..."]
workson: []
hugoversion:
relatedfuncs: []
deprecated: false
aliases: []
needsexamples: true
---
`dict` creates a dictionary `(map[string, interface{})` that expects parameters added in a value:object fashion.

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: []
ns:
signature: ["echoParam DICTIONARY KEY"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [strings,emojis]
ns:
signature: ["emojify INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [operators,logic]
ns:
signature: ["eq ARG1 ARG2"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [regex]
ns:
signature: ["findRE PATTERN INPUT [LIMIT]"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [iteration]
ns:
signature: ["first LIMIT COLLECTION"]
workson: [lists,taxonomies,terms,groups]
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [dates,time]
ns:
signature: ["Format FORMAT"]
workson: [times]
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [shortcodes]
ns:
signature: ["Get INDEX", "Get KEY"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: []
ns:
signature: ["getenv VARIABLE"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: []
ns:
signature: ["hasPrefix STRING PREFIX"]
workson: []
hugoversion:

View File

@ -12,7 +12,6 @@ menu:
parent: "functions"
#tags: [menus]
toc:
ns:
signature: ["HasChildren"]
workson: [menus]
hugoversion:
@ -20,7 +19,6 @@ relatedfuncs: []
deprecated: false
draft: true
aliases: []
needsexamples: true
---
Used in [menu templates](/templates/menu-templates/).

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [menus]
ns:
signature: ["HasMenuCurrent"]
workson: [menus]
hugoversion:
@ -20,7 +19,6 @@ deprecated: false
toc: false
draft: true
aliases: []
needsexamples: true
---
Used in [menu templates](/templates/menu-templates/).

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [highlighting,pygments,code blocks,syntax]
ns:
signature: ["highlight INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [strings, html]
ns:
signature: ["htmlEscape INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: []
ns:
signature: ["htmlUnescape INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [strings,casing]
ns:
signature: ["humanize INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [internationalization,i18n,multilingual]
ns:
signature: ["i18n KEY", "T KEY"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [images]
ns:
signature: ["imageConfig PATH"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [strings]
ns:
signature: ["in SET ITEM"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: []
ns:
signature: ["index COLLECTION INDEX", "index COLLECTION KEY"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [strings,integers]
ns:
signature: ["int INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: []
ns:
signature: ["intersect SET1 SET2"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [menus]
ns:
signature: ["IsMenuCurrent"]
workson: [menus]
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: []
ns:
signature: ["isset COLLECTION INDEX", "isset COLLECTION KEY"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [strings,json]
ns:
signature: ["jsonify INPUT"]
workson: []
hugoversion:

View File

@ -12,7 +12,6 @@ menu:
docs:
parent: "functions"
toc:
ns:
signature: ["last INDEX COLLECTION"]
workson: [lists, taxonomies, terms, groups]
hugoversion:

View File

@ -8,7 +8,6 @@ publishdate: 2017-02-01
lastmod: 2017-04-18
categories: [functions]
#tags: []
ns:
signature: ["len INPUT"]
workson: [lists,taxonomies,terms]
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [strings,casing]
ns:
signature: ["lower INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ categories: [functions]
menu:
docs:
parent: "functions"
ns:
signature: ["markdownify INPUT"]
workson: []
hugoversion:

View File

@ -12,7 +12,6 @@ menu:
docs:
parent: "functions"
toc:
ns:
signature: []
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: []
ns:
signature: ["md5 INPUT"]
workson: []
hugoversion:

View File

@ -11,14 +11,12 @@ menu:
docs:
parent: "functions"
#tags: [dates,time]
ns:
signature: ["now"]
workson: []
hugoversion:
relatedfuncs: [Unix,dateFormat]
deprecated: false
aliases: []
needsexamples: true
---
`now` returns the current local time as a [`time.Time`](https://godoc.org/time#Time).

View File

@ -12,7 +12,6 @@ menu:
docs:
parent: "functions"
toc:
ns:
signature: ["Param KEY"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: []
ns:
signature: ["partialCached LAYOUT INPUT [VARIANT...]"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [strings]
ns:
signature: ["plainify INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [strings]
ns:
signature: ["pluralize INPUT"]
workson: []
hugoversion:

View File

@ -11,13 +11,11 @@ menu:
docs:
parent: "functions"
#tags: [strings]
ns:
signature: ["printf FORMAT INPUT"]
workson: []
hugoversion:
relatedfuncs: []
deprecated: false
needsexamples: true
---
`printf` formats a string using the standard `fmt.Sprintf` function. See [the go doc](https://golang.org/pkg/fmt/) for additional information.

View File

@ -11,7 +11,6 @@ menu:
parent: "functions"
#tags: [urls]
godocref:
ns:
signature: ["querify KEY VALUE [KEY VALUE]..."]
hugoversion:
deprecated: false

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [iteration]
ns:
signature: ["range COLLECTION"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [files]
ns:
signature: ["readDir PATH"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [files]
ns:
signature: ["readFile PATH"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [cross references, anchors]
ns:
signature: ["ref PAGE CONTENT"]
workson: []
hugoversion:

View File

@ -11,14 +11,12 @@ categories: [functions]
menu:
docs:
parent: "functions"
ns:
signature: ["relLangURL INPUT"]
workson: []
hugoversion:
relatedfuncs: []
deprecated: false
aliases: []
needsexamples: true
---
`absLangURL` and `relLangURL` functions are similar to their [`absURL`](/functions/absurl/) and [`relURL`](/functions/relurl/) relatives but will add the correct language prefix when the site is configured with more than one language. (See [Configuring Multilingual][multiliconfig].)

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [cross references, anchors]
ns:
signature: ["relref PAGE CONTENT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [urls]
ns:
signature: ["relURL INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [views]
ns:
signature: ["render LAYOUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: []
ns:
signature: ["replace INPUT OLD NEW"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [regex]
ns:
signature: ["replaceRE PATTERN REPLACEMENT INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [style,css,strings]
ns:
signature: ["safeCSS INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [strings]
ns:
signature: ["safeHTML INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [strings]
ns:
signature: ["safeHTMLAttr INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [strings]
ns:
signature: ["safeJS INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ categories: [functions]
menu:
docs:
parent: "functions"
ns:
signature: ["safeURL INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
toc:
ns:
signature: []
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: []
ns:
signature: ["seq LAST", "seq FIRST LAST", "seq FIRST INCREMENT LAST"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [sha,checksum]
ns:
signature: ["sha1 INPUT", "sha256 INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ categories: [functions]
menu:
docs:
parent: "functions"
ns:
signature: ["shuffle COLLECTION"]
workson: []
hugoversion:
@ -19,7 +18,6 @@ relatedfuncs: [seq]
deprecated: false
draft: false
aliases: []
needsexamples: true
---
`shuffle` returns a random permutation of a given array or slice:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [strings,singular]
ns:
signature: ["singularize INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [slice, array, interface]
ns:
signature: ["slice ITEM..."]
workson: []
hugoversion:
@ -20,7 +19,6 @@ deprecated: false
draft: false
aliases: []
toc: false
needsexamples: true
---
`slice` allows you to create an array (`[]interface{}`) of all arguments that you pass to this function.

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [strings]
ns:
signature: ["slicestr STRING START [END]"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [ordering,sorting,lists]
ns:
signature: []
workson: [lists,taxonomies,terms,groups]
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [strings]
ns:
signature: ["split STRING DELIM"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [strings]
ns:
signature: ["string INPUT"]
workson: []
hugoversion:

View File

@ -12,7 +12,6 @@ menu:
parent: "functions"
#tags: [strings]
aliases: []
ns:
signature: ["substr STRING START [LENGTH]"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [dates,time]
ns:
signature: ["time INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [strings]
ns:
signature: ["title INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [strings]
ns:
signature: ["trim INPUT CUTSET"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [strings]
ns:
signature: ["truncate SIZE INPUT", "truncate SIZE ELLIPSIS INPUT"]
workson: []
hugoversion: 19

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [filtering,lists]
ns:
signature: ["union SET1 SET2"]
workson: []
hugoversion: 0.20

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [multilingual,i18n,urls]
ns:
signature: ["uniq SET"]
workson: []
hugoversion:

View File

@ -14,7 +14,6 @@ categories: [functions]
menu:
docs:
parent: "functions"
ns:
signature: ["Unix"]
workson: [times]
hugoversion:

View File

@ -12,7 +12,6 @@ menu:
docs:
parent: "functions"
toc:
ns:
signature: ["upper INPUT"]
workson: []
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
parent: "functions"
#tags: [urls,strings]
godocref:
ns:
signature: ["urlize INPUT"]
hugoversion:
deprecated: false

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [filtering]
ns:
signature: ["where COLLECTION KEY [OPERATOR] MATCH"]
workson: [lists,taxonomies,terms,groups]
hugoversion:

View File

@ -11,7 +11,6 @@ menu:
docs:
parent: "functions"
#tags: [conditionals]
ns:
signature: ["with INPUT"]
workson: []
hugoversion:

View File

@ -1,7 +0,0 @@
<ul class="utils-list">
{{range .Site.Pages }}
{{ if .Params.needsexamples }}
<li><a href="{{.Site.Params.ghdocsrepo}}content/{{.File.Path}}" target="_blank">{{.Title}} <i class="icon-pencil"></i></a></li>
{{ end }}
{{ end }}
</ul>

@ -1 +1 @@
Subproject commit cbd3d82039a5da47cd68c98001f2f6976b75cee3
Subproject commit ad6692b717d3f535a62e300e79ed1bc7fab39254