kjuulh/dagger
Archived
1
0
Fork 0
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity

Temporary fix for markdownlint

Browse Source 
Signed-off-by: Joel Longtine <joel@dagger.io>
This commit is contained in:
Joel Longtine 2022-02-21 15:25:30 -07:00
parent a768ed13c7
commit eeb20a3999
2 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
cmd/dagger/cmd/doc.go
View File

@ -334,7 +334,9 @@ func walkStdlib(ctx context.Context, output, format string) {
lg.Fatal().Err(err).Msg("cannot generate stdlib doc index") lg.Fatal().Err(err).Msg("cannot generate stdlib doc index")
} }
defer index.Close() defer index.Close()
fmt.Fprintf(index, "# Index\n\n") // FIXME: I removed a \n character, so that markdownlint doesn't complain
// about an extra newline at the end of the file.
fmt.Fprintf(index, "# Index\n")
indexKeys := []string{} indexKeys := []string{}
for p, pkg := range packages { for p, pkg := range packages {
@ -357,6 +359,11 @@ func walkStdlib(ctx context.Context, output, format string) {
// Generate index from sorted list of packages // Generate index from sorted list of packages
sort.Strings(indexKeys) sort.Strings(indexKeys)
// Add a extra blank line if we have at least one package
// TODO: this is a hack, fixes issue with markdownlint, if we haven't generated any docs.
if len(indexKeys) > 0 {
fmt.Fprintf(index, "\n")
}
for _, p := range indexKeys { for _, p := range indexKeys {
description := mdEscape(packages[p].Description) description := mdEscape(packages[p].Description)
fmt.Fprintf(index, "- [%s](./%s) - %s\n", p, getFileName(p), description) fmt.Fprintf(index, "- [%s](./%s) - %s\n", p, getFileName(p), description)

1
docs/reference/README.md
View File

@ -1,2 +1 @@
# Index # Index