[PATCH] D43505: [docs] Use literalinclude for most code in the Kaleidoscope tutorial to ensure the code always compiles and is up to date

David Blaikie via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Wed Feb 21 12:00:32 PST 2018


dblaikie added a comment.

Love this!

Though the ":lines: X, Y" doesn't seem to do the right thing for me (using sphinx-build v1.5.6 on my Ubuntu system). Any of the code samples that use the 'lines:' property end up empty for me.

Any ideas?

Though honestly, I'm thinking maybe it'd be better to not 'lines:' property anyway. Perhaps it's better to have the start/end comments in the source so when code is refactored, line wrapped, etc, the line counts don't end up becoming out of date?

Nitpick: Might be good to keep any whitespace that was present before (in some cases an empty line has been replaced with two comments (the end of one region and the start of the next) - perhaps keep the empty line between those two comments, for readibility and to reduce the noise in this diff)?


Repository:
  rL LLVM

https://reviews.llvm.org/D43505





More information about the llvm-commits mailing list