Skip to content

Commit 2f952af

Browse files
committed
docs/lib: rename 'name' → 'category'
1 parent c146f6e commit 2f952af

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/lib/default.nix

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,13 @@ let
7272
function docgen {
7373
md_file="$1"
7474
in_file="$2"
75-
name="$3"
75+
category="$3"
7676
out_file="$out/$4"
7777
title="$5"
7878
7979
if [[ -z "$in_file" ]]; then
8080
if [[ -z "$md_file" ]]; then
81-
>&2 echo "No markdown or nix file for $name"
81+
>&2 echo "No markdown or nix file for $category"
8282
exit 1
8383
fi
8484
elif [[ -f "$in_file/default.nix" ]]; then
@@ -92,7 +92,7 @@ let
9292
nixdoc \
9393
--file "$in_file" \
9494
--locs "$locations" \
95-
--category "$name" \
95+
--category "$category" \
9696
--description "REMOVED BY TAIL" \
9797
--prefix "lib" \
9898
--anchor-prefix "" \
@@ -103,7 +103,7 @@ let
103103
print_title=true
104104
if [[ -f "$md_file" ]] && [[ "$(head --lines 1 "$md_file")" == '# '* ]]; then
105105
if [[ -n "$title" ]]; then
106-
>&2 echo "NOTE: markdown file for $name starts with a <h1> heading. Skipping title \"$title\"."
106+
>&2 echo "NOTE: markdown file for $category starts with a <h1> heading. Skipping title \"$title\"."
107107
>&2 echo " Found \"$(head --lines 1 "$md_file")\" in: $md_file"
108108
fi
109109
print_title=false
@@ -139,7 +139,7 @@ let
139139
"docgen"
140140
"${lib.optionalString (source != null) source}" # md_file
141141
"${lib.optionalString (functions.file != null) functions.file}" # in_file
142-
(lib.showAttrPath functions.loc) # name
142+
(lib.showAttrPath functions.loc) # category
143143
target # out_file
144144
title # title
145145
]

0 commit comments

Comments
 (0)