Skip to content

Commit

Permalink
[SPARK-12035] Add more debug information in include_example tag of Je…
Browse files Browse the repository at this point in the history
…kyll

https://issues.apache.org/jira/browse/SPARK-12035

When we debuging lots of example code files, like in #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.
  • Loading branch information
yinxusen authored and Andrew Or committed Dec 1, 2015
1 parent d3ca8cf commit e6dc89a
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions docs/_plugins/include_example.rb
Expand Up @@ -75,19 +75,21 @@ def select_lines(code)
.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
# blocks.
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
Expand Down

0 comments on commit e6dc89a

Please sign in to comment.