From c39d132827770daf2e14deab507b5a294d71807c Mon Sep 17 00:00:00 2001 From: Moelf Date: Fri, 10 Dec 2021 23:39:50 -0500 Subject: [PATCH] add docs --- docs/src/features/code_src.md | 15 +++++++++++++++ docs/src/index.md | 1 + 2 files changed, 16 insertions(+) create mode 100644 docs/src/features/code_src.md diff --git a/docs/src/features/code_src.md b/docs/src/features/code_src.md new file mode 100644 index 0000000..7df3407 --- /dev/null +++ b/docs/src/features/code_src.md @@ -0,0 +1,15 @@ +# `@code_src` macro + +The macro allows you to display source code of a method in-line, +just like `@code_llvm` and `@code_typed`. Inspired by: +https://github.com/JuliaLang/julia/issues/2625#issuecomment-498840808 + +```julia-repl +julia> @code_src sum(1:3) +function sum(r::AbstractRange{<:Real}) + l = length(r) + # note that a little care is required to avoid overflow in l*(l-1)/2 + return l * first(r) + (iseven(l) ? (step(r) * (l-1)) * (l>>1) + : (step(r) * l) * ((l-1)>>1)) +end +``` diff --git a/docs/src/index.md b/docs/src/index.md index 6247b48..0e0a41a 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -19,6 +19,7 @@ Pages = [ "features/rainbow_brackets.md", "features/markdown_highlight.md", "features/fzf.md", + "features/code_src.md", "internals/passes.md" ] Depth = 1