summaryrefslogtreecommitdiff
path: root/utils
diff options
context:
space:
mode:
authorViktor Söderqvist <viktor.soderqvist@est.tech>2022-05-03 09:34:18 +0200
committerGitHub <noreply@github.com>2022-05-03 10:34:18 +0300
commitced710fc8304fd24251514c87bd15008b2a3b1dd (patch)
tree7f5f943f1940c16d3caed72c7d8881b45db8ec47 /utils
parentf44c34329217a46a8918c476ba3690b6a102c696 (diff)
downloadredis-ced710fc8304fd24251514c87bd15008b2a3b1dd.tar.gz
Module API doc script: Mark unreleased API functions (#10674)
* Module API doc script: Mark unreleased API functions * fix broken quotes in generate-module-api-doc.rb Co-authored-by: Oran Agra <oran@redislabs.com>
Diffstat (limited to 'utils')
-rwxr-xr-xutils/generate-module-api-doc.rb7
1 files changed, 3 insertions, 4 deletions
diff --git a/utils/generate-module-api-doc.rb b/utils/generate-module-api-doc.rb
index cba08f765..1f7b7c2e5 100755
--- a/utils/generate-module-api-doc.rb
+++ b/utils/generate-module-api-doc.rb
@@ -1,5 +1,4 @@
#!/usr/bin/env ruby
-
# coding: utf-8
# gendoc.rb -- Converts the top-comments inside module.c to modules API
# reference documentation in markdown format.
@@ -80,7 +79,7 @@ def docufy(src,i)
puts "<span id=\"#{name}\"></span>\n\n"
puts "### `#{name}`\n\n"
puts " #{proto}\n"
- puts "**Available since:** #{$since[name]}\n\n" if $since[name]
+ puts "**Available since:** #{$since[name] or "unreleased"}\n\n"
comment = ""
while true
i = i-1
@@ -138,8 +137,8 @@ def is_func_line(src, i)
end
puts "---\n"
-puts "title: "Modules API reference"\n"
-puts "linkTitle: "API reference"\n"
+puts "title: \"Modules API reference\"\n"
+puts "linkTitle: \"API reference\"\n"
puts "weight: 1\n"
puts "description: >\n"
puts " Reference for the Redis Modules API\n"