From 817e702aa05f22d85fa16a8cf7ff8eb4cf363deb Mon Sep 17 00:00:00 2001 From: John Pignata Date: Thu, 10 Dec 2015 15:35:50 -0500 Subject: [PATCH] Improve content formatting * Replace @example syntax with Markdown header * Only replace the first comment hash to preserve in-example comment lines * Indent code lines --- lib/tasks/docs.rake | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/tasks/docs.rake b/lib/tasks/docs.rake index c3a08cd2..7b66c165 100644 --- a/lib/tasks/docs.rake +++ b/lib/tasks/docs.rake @@ -14,8 +14,10 @@ namespace :docs do class_doc = content.match(/(\s+#.*)+/).to_s doc_lines = class_doc. gsub(/^\n/,""). + gsub("@example", "### Example:"). split("\n"). - map { |line| line.gsub(/\s+#\s?/, "") }. + map { |line| line.gsub(/\A\s+#\s?/, "") }. + map { |line| line.gsub(/\A\s{2}/, " " * 4) }. join("\n") hash[file] = doc_lines end