Update docs

This commit is contained in:
2026-05-03 21:21:38 +02:00
parent 99c8e12f40
commit b9e81c7e49
9 changed files with 329 additions and 169 deletions

View File

@@ -17,7 +17,7 @@ const KatenaryLabelPrefix = "katenary.v3"
```
<a name="GetLabelHelp"></a>
## func [GetLabelHelp](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/katenaryLabels.go#L90>)
## func GetLabelHelp
```go
func GetLabelHelp(asMarkdown bool) string
@@ -26,7 +26,7 @@ func GetLabelHelp(asMarkdown bool) string
GetLabelHelp return the help for the labels.
<a name="GetLabelHelpFor"></a>
## func [GetLabelHelpFor](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/katenaryLabels.go#L99>)
## func GetLabelHelpFor
```go
func GetLabelHelpFor(labelname string, asMarkdown bool) string
@@ -35,7 +35,7 @@ func GetLabelHelpFor(labelname string, asMarkdown bool) string
GetLabelHelpFor returns the help for a specific label.
<a name="GetLabelNames"></a>
## func [GetLabelNames](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/katenaryLabels.go#L74>)
## func GetLabelNames
```go
func GetLabelNames() []string
@@ -44,7 +44,7 @@ func GetLabelNames() []string
GetLabelNames returns a sorted list of all katenary label names.
<a name="Prefix"></a>
## func [Prefix](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/katenaryLabels.go#L237>)
## func Prefix
```go
func Prefix() string
@@ -53,7 +53,7 @@ func Prefix() string
<a name="Help"></a>
## type [Help](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/katenaryLabels.go#L66-L71>)
## type Help
Help is the documentation of a label.
@@ -67,7 +67,7 @@ type Help struct {
```
<a name="Label"></a>
## type [Label](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/katenaryLabels.go#L59>)
## type Label
Label is a katenary label to find in compose files.
@@ -100,7 +100,7 @@ const (
```
<a name="LabelName"></a>
### func [LabelName](<https://repo.katenary.io/Katenary/katenary/blob/feature/better-depends-on/internal/generator/labels/katenaryLabels.go#L61>)
### func LabelName
```go
func LabelName(name string) Label