From e6dc89a33951e9197a77dbcacf022c27469ae41e Mon Sep 17 00:00:00 2001
From: Xusen Yin <yinxusen@gmail.com>
Date: Mon, 30 Nov 2015 17:18:44 -0800
Subject: [PATCH] [SPARK-12035] Add more debug information in include_example
tag of Jekyll
https://issues.apache.org/jira/browse/SPARK-12035
When we debuging lots of example code files, like in https://github.com/apache/spark/pull/10002, it's hard to know which file causes errors due to limited information in `include_example.rb`. With their filenames, we can locate bugs easily.
Author: Xusen Yin <yinxusen@gmail.com>
Closes #10026 from yinxusen/SPARK-12035.
---
docs/_plugins/include_example.rb | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/docs/_plugins/include_example.rb b/docs/_plugins/include_example.rb
index 564c86680f..f7485826a7 100644
--- a/docs/_plugins/include_example.rb
+++ b/docs/_plugins/include_example.rb
@@ -75,10 +75,10 @@ module Jekyll
.select { |l, i| l.include? "$example off$" }
.map { |l, i| i }
- raise "Start indices amount is not equal to end indices amount, please check the code." \
+ raise "Start indices amount is not equal to end indices amount, see #{@file}." \
unless startIndices.size == endIndices.size
- raise "No code is selected by include_example, please check the code." \
+ raise "No code is selected by include_example, see #{@file}." \
if startIndices.size == 0
# Select and join code blocks together, with a space line between each of two continuous
@@ -86,8 +86,10 @@ module Jekyll
lastIndex = -1
result = ""
startIndices.zip(endIndices).each do |start, endline|
- raise "Overlapping between two example code blocks are not allowed." if start <= lastIndex
- raise "$example on$ should not be in the same line with $example off$." if start == endline
+ raise "Overlapping between two example code blocks are not allowed, see #{@file}." \
+ if start <= lastIndex
+ raise "$example on$ should not be in the same line with $example off$, see #{@file}." \
+ if start == endline
lastIndex = endline
range = Range.new(start + 1, endline - 1)
result += trim_codeblock(lines[range]).join
--
GitLab