doctests for metaprogramming #20302

KristofferC · 2017-01-28T22:20:05Z

No description provided.

KristofferC · 2017-01-28T22:20:31Z

doc/src/manual/metaprogramming.md

 julia> typeof(ex)
 Expr

 julia> ex
-:(println("I execute at runtime. The argument is: ",$(Expr(:copyast, :(:((1,2,3)))))))
+:((println)("I execute at runtime. The argument is: ",$(Expr(:copyast, :($(QuoteNode(:((1,2,3)))))))))


This printing seems to be a bit less nice now perhaps

fredrikekre · 2017-01-28T22:26:33Z

doc/src/manual/metaprogramming.md

@@ -305,9 +304,9 @@ julia> a = 1;
 julia> ex = Expr(:call, :+, a, :b)
 :(1 + b)

-julia> a = 0; b = 2;
+julia> a = 0;  b = 2;


kshyatt · 2017-01-28T22:27:44Z

Why am I assigned but not a reviewer? What are you trying to tell me?? 😆

KristofferC · 2017-01-28T22:29:46Z

I thought that was the same thing sortof...

kshyatt · 2017-01-28T22:31:56Z

doc/src/manual/metaprogramming.md

@@ -263,29 +263,28 @@ julia> eval(ans)
 julia> ex = :(a + b)
 :(a + b)

-julia> eval(ex)
+julia> eval(current_module(), ex)


should we add some text explaining what current_module() is and why it's here?

Yeah probably. It's not neeed in the REPL but since the doctests are run in a separate module I think it is needed.

I'd say that's a bug in Documenter, shouldn't need to jump through those kind of hoops. I'll see what can be done about it.

If that gets resolved then the closest-candidates from #20224 (comment) can probably be brought back too

kshyatt · 2017-01-28T22:32:28Z

doc/src/manual/metaprogramming.md

@@ -393,23 +393,24 @@ instances of `@sayhello` with:
 When `@sayhello` is given at the REPL, the expression executes immediately, thus we only see the


"given at the REPL" is weird phrasing

kshyatt · 2017-01-28T22:33:59Z

doc/src/manual/metaprogramming.md


-julia> # start some other operations that use f(x):
+Start some other operations that use f(x):


As a standalone sentence this doesn't work very well. I'd say something like "define other operations that use f(x)"

kshyatt · 2017-01-28T22:34:09Z

doc/src/manual/metaprogramming.md


-julia> # now we add some new definitions for f(x):
+We now add some new definitions for f(x):


Forgot backticks

kshyatt · 2017-01-28T22:34:39Z

doc/src/manual/metaprogramming.md

+ end
+ return :($ex + 1)
+ end
+sub2ind_gen (generic function with 1 method)
 ```

 **What code will this generate?**

 An easy way to find out, is to extract the body into another (regular) function:


again not your fault but this comma shouldn't be here

tkelman · 2017-01-28T22:35:22Z

doc/src/manual/metaprogramming.md

+ return :($ex ? nothing : throw(AssertionError($msg)))
+ end
+@assert (macro with 1 method)
+


no need for the empty line

tkelman · 2017-01-28T22:36:18Z

doc/src/manual/metaprogramming.md


-julia> # start some other operations that use f(x):
+Start some other operations that use f(x):


code highlight f(x)

fredrikekre · 2017-01-28T23:03:06Z

doc/src/manual/metaprogramming.md

@@ -419,9 +420,9 @@ this is an extremely useful tool for debugging macros):

 ```julia
 julia> ex = macroexpand( :(@sayhello("human")) )


Perhaps clearer by using the @macroexpand macro?

julia> ex = @macroexpand @sayhello "human" :((Main.println)("Hello, ","human"))

to avoid the extra quoting stuff?

And could be doctested if the note on the interpolated string is extracted and added afterwards instead

tkelman · 2017-01-28T23:17:40Z

doc/src/manual/metaprogramming.md


 julia> typeof(ex)
 Expr
 ```

+We can see that the `"human"` literal has been interpolated into the expression.
+
+There also exists a macro [`@macroexpand`][@ref] that is perhaps a bit more convenient than the `macroexpand` function:


@ref should be in ( ) not [ ]

Sorry, will update.

KristofferC · 2017-01-29T17:23:08Z

doc/src/manual/metaprogramming.md


 julia> ex = macroexpand( :(@twostep :(1, 2, 3)) );
-I execute at parse time. The argument is: :((1,2,3))
+I execute at parse time. The argument is: $(Expr(:quote, :((1,2,3))))


This printing is also a bit less "nice"

KristofferC · 2017-01-31T08:44:41Z

Updated for newest documenter (could remove current_module()). All doctest + whitespace passes locally.

tkelman · 2017-01-31T08:58:58Z

doc/src/manual/metaprogramming.md

+ end
+ return :($ex + 1)
+ end
+sub2ind_gen (generic function with 1 method)


should this be called to verify that it works?

yeah, makes sense

KristofferC · 2017-01-31T09:31:55Z

Updated to test another function. Doctests still passes locally.

tkelman · 2017-02-04T05:09:14Z

doc/src/manual/metaprogramming.md

 julia> @generated function sub2ind_gen{N}(dims::NTuple{N}, I::Integer...)
 return sub2ind_gen_impl(dims, I...)
 end
 sub2ind_gen (generic function with 1 method)

-julia> function sub2ind_gen_impl{N}(dims::Type{NTuple{N}}, I...)
+julia> function sub2ind_gen_impl(dims::Type{T}, I...) where T <: NTuple{N,Any} where N


might be a little more readable as where T <: (NTuple{N,Any} where N)

KristofferC assigned kshyatt Jan 28, 2017

KristofferC commented Jan 28, 2017

View reviewed changes

KristofferC mentioned this pull request Jan 28, 2017

Doctest ALL the things #20274

Closed

38 tasks

KristofferC assigned kshyatt and unassigned kshyatt Jan 28, 2017

fredrikekre reviewed Jan 28, 2017

View reviewed changes

kshyatt added the docs This change adds or pertains to documentation label Jan 28, 2017

KristofferC unassigned kshyatt Jan 28, 2017

KristofferC requested a review from kshyatt January 28, 2017 22:29

kshyatt reviewed Jan 28, 2017

View reviewed changes

tkelman reviewed Jan 28, 2017

View reviewed changes

KristofferC force-pushed the kc/doctest_metaprogramming branch from 6da1d5c to 17c14f6 Compare January 28, 2017 22:54

fredrikekre reviewed Jan 28, 2017

View reviewed changes

tkelman reviewed Jan 28, 2017

View reviewed changes

KristofferC commented Jan 29, 2017

View reviewed changes

tkelman mentioned this pull request Jan 31, 2017

Update doc deps #20329

Merged

KristofferC force-pushed the kc/doctest_metaprogramming branch from 88e3772 to 13c0a8b Compare January 31, 2017 08:44

tkelman reviewed Jan 31, 2017

View reviewed changes

KristofferC added 3 commits February 3, 2017 17:01

doctests for metaprogramming [ci skip]

9c04de9

address comments

396f818

add some stuff about new macroexpand macro

040ffd9

KristofferC added 5 commits February 3, 2017 17:01

some updates

a90f776

update for new Documenter [ci skip]

489e58d

checkoutput from sub2ind_gen [ci skip]

041592e

test another example [ci skip]

86e77de

update for space PR [ci skip]

e5d2d58

KristofferC force-pushed the kc/doctest_metaprogramming branch from 2c9b715 to e5d2d58 Compare February 3, 2017 16:06

KristofferC merged commit 2f8ad04 into master Feb 3, 2017

KristofferC deleted the kc/doctest_metaprogramming branch February 3, 2017 17:34

tkelman reviewed Feb 4, 2017

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doctests for metaprogramming #20302

doctests for metaprogramming #20302

KristofferC commented Jan 28, 2017

KristofferC Jan 28, 2017

fredrikekre Jan 28, 2017

KristofferC Jan 28, 2017

kshyatt commented Jan 28, 2017

KristofferC commented Jan 28, 2017

kshyatt Jan 28, 2017

KristofferC Jan 28, 2017

MichaelHatherly Jan 29, 2017

KristofferC Jan 29, 2017

tkelman Jan 29, 2017

kshyatt Jan 28, 2017

kshyatt Jan 28, 2017

kshyatt Jan 28, 2017

kshyatt Jan 28, 2017

tkelman Jan 28, 2017

tkelman Jan 28, 2017

fredrikekre Jan 28, 2017

fredrikekre Jan 28, 2017

tkelman Jan 28, 2017

KristofferC Jan 28, 2017

KristofferC Jan 29, 2017

KristofferC commented Jan 31, 2017

tkelman Jan 31, 2017

KristofferC Jan 31, 2017

KristofferC Jan 31, 2017

KristofferC commented Jan 31, 2017 •

edited

Loading

tkelman Feb 4, 2017

		@@ -393,23 +393,24 @@ instances of `@sayhello` with:
		When `@sayhello` is given at the REPL, the expression executes immediately, thus we only see the


		julia> # start some other operations that use f(x):
		Start some other operations that use f(x):


		julia> # now we add some new definitions for f(x):
		We now add some new definitions for f(x):

		@@ -419,9 +420,9 @@ this is an extremely useful tool for debugging macros):

		```julia
		julia> ex = macroexpand( :(@sayhello("human")) )

doctests for metaprogramming #20302

doctests for metaprogramming #20302

Conversation

KristofferC commented Jan 28, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kshyatt commented Jan 28, 2017

KristofferC commented Jan 28, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KristofferC commented Jan 31, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KristofferC commented Jan 31, 2017 • edited Loading

Choose a reason for hiding this comment

KristofferC commented Jan 31, 2017 •

edited

Loading