Browse Source

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>
pull/10681/head
Viktor Söderqvist 2 months ago committed by GitHub
parent
commit
ced710fc83
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 7
      utils/generate-module-api-doc.rb

7
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"

Loading…
Cancel
Save