Arc Forumnew | comments | leaders | submitlogin
1 point by akkartik 1314 days ago | link | parent

Ok, so you'd be satisfied if we just included the examples in docstrings?


2 points by shader 1313 days ago | link

No, unless you wanted to dynamically read the examples from the docstrings to evaluate them when the examples are queried, either directly or as part of help.

Actually, I don't know if the examples should be automatically displayed with 'help, or queried separately.

Either way, it would be nice to make them automatically evaluated, unless they can't be for whatever reason. It seems like that would be easiest to do with something like the existing examples macro, but if you think it would be doable with docstrings I guess that could work.

-----

1 point by akkartik 1313 days ago | link

Ah, ok. So you don't care about being able to see them next to the function, but you would like some way to see them at the repl along with their results. Let me know if I'm still missing something.

(Sorry I'm asking basic questions. The discussion has ranged far enough that I just want to circle back to nail down precisely what you're suggesting among all the use cases and possible UIs.)

-----

2 points by shader 1312 days ago | link

Well, that's what I'm suggesting. I don't see the other cases as essential, and the interface seems simpler that way. I'm lazy too, which means that if I'm making examples, I'd rather not have to provide the results. Not that I couldn't, but I'd like the option at least to do otherwise.

As always, you don't have to change anything just to meet my opinions. I'm used to being in the minority, in fact.

-----

1 point by akkartik 1312 days ago | link

Thanks! Just want to record your feedback for the record. We'll see if I do anything about it.

-----

1 point by akkartik 1311 days ago | link

(It's not yet clear what the majority opinion is here.)

-----

2 points by shader 1311 days ago | link

Maybe nobody else cares. It's a pretty small community at this point anyway, and I doubt everyone checks daily. I know I've gone through long periods without checking.

-----