Questions about scribble/examples

[Alexis King]

I’ve noticed the recent addition of scribble/examples to scribble-lib. First
of all, I’m super excited about having a more robust interface to
scribble/eval, and from the documentation, it looks great.

I do have a couple questions, though.

1. Should the name of this module be scribble/examples or
scribble/example, given that the style guide recommends only singular
names? I get that in this case, it might make sense to have the plural
name since the form it exports is called `examples`, but I figured I’d
raise the question before the name is set in stone.

2. Is eval:check “fixed”? It seemed to be completely broken when I tried
it a number of months ago. I fixed it to at least work, but the source
location information was screwy. Now, though, it seems to work okay.
Matthew, did any of the changes you made fix this issue, or am I just
imagining things?

Again, the changes look wonderful overall, so thanks a lot for taking the
time to revamp and older, oft-used API. It would be nice if some of the other
Racket libraries could get some similar love.

Alexis

[Matthew Flatt]

At Fri, 11 Dec 2015 13:25:25 -0800, Alexis King wrote:
> I’ve noticed the recent addition of scribble/examples to scribble-lib. First
> of all, I’m super excited about having a more robust interface to
> scribble/eval, and from the documentation, it looks great.

Thanks for taking a look! In retrospect, I should have made this a pull
request, because I'd really like others to take a close look.

Besides reconsidering the library name (as below), you may think of
other simplifications, improvements, or better names. Try it out on
your documentation, but let's agree that the API might be in flux for a
little while.

> I do have a couple questions, though.
>
> 1. Should the name of this module be scribble/examples or
> scribble/example, given that the style guide recommends only singular
> names? I get that in this case, it might make sense to have the plural
> name since the form it exports is called `examples`, but I figured I’d
> raise the question before the name is set in stone.

I agree that `scribble/example` is the right name according to the
style guide. I broke the rule here on purpose, because the main export
of `scribble/examples` is `examples`, and the mismatch between
`examples` and `scribble/example` bothered me.

I am not sure I made the right choice in breaking the guideline,
though. If other think that `scribble/example` would be better, I can
easily agree.

> 2. Is eval:check “fixed”? It seemed to be completely broken when I tried
> it a number of months ago. I fixed it to at least work, but the source
> location information was screwy. Now, though, it seems to work okay.
> Matthew, did any of the changes you made fix this issue, or am I just
> imagining things?

I fixed some problems with `eval:check` along the way.

[Benjamin Greenman]

+1 scribble/example

--
You received this message because you are subscribed to the Google Groups "Racket Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to racket-dev+...@googlegroups.com.
To post to this group, send email to racke...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/racket-dev/566b4131.ca42420a.98fe2.5090SMTPIN_ADDED_MISSING%40mx.google.com.

For more options, visit https://groups.google.com/d/optout.

[Jack Firth]

I made a package doing some of this, and I'm quite happy to see this feature included with scribble. Where can I find docs for it's api however?

[Matthew Flatt]

At Fri, 11 Dec 2015 15:46:01 -0800 (PST), Jack Firth wrote:
> I made a package doing some of this, and I'm quite happy to see this
> feature included with scribble. Where can I find docs for it's api however?

The `scribble/examples` library is documented in the Scribble manual,
since it's intended as a replacement for the `scribble/eval` library
documented there.

[Matthew Flatt]

At Fri, 11 Dec 2015 15:46:01 -0800 (PST), Jack Firth wrote:

> I made a package doing some of this, and I'm quite happy to see this
> feature included with scribble. Where can I find docs for it's api however?