Skip to content

Commit

Permalink
Fix doc generation for obsolete settings
Browse files Browse the repository at this point in the history
  • Loading branch information
suyograo authored and jordansissel committed Oct 26, 2015
1 parent bf4c5a3 commit 3da7238
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 1 deletion.
1 change: 0 additions & 1 deletion docs/asciidocgen.rb
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,6 @@ def generate(file, settings)
description = @class_description

klass.get_config.each do |name, settings|
next if settings[:obsolete]
@attributes[name].merge!(settings)
default = klass.get_default(name)
unless default.nil?
Expand Down
1 change: 1 addition & 0 deletions docs/plugin-doc.asciidoc.erb
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ This plugin has no configuration options.

<% sorted_attributes.each do |name, config| -%>
<%
next if config[:obsolete]
if name.is_a?(Regexp)
name = "/" + name.to_s.gsub(/^\(\?-mix:/, "").gsub(/\)$/, "") + "/"
is_regexp = true
Expand Down
1 change: 1 addition & 0 deletions docs/plugin-synopsis.asciidoc.erb
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Available configuration options:
|=======================================================================
|Setting |Input type|Required|Default value
<% sorted_attributes.each do |name, config|
next if config[:obsolete]
next if config[:deprecated]
if config[:validate].is_a?(Array)
annotation = "|<<string,string>>, one of `#{config[:validate].inspect}`"
Expand Down

0 comments on commit 3da7238

Please sign in to comment.