search

probcomp / iventure

An interactive, browser-based probabilistic programming environment.
Apache License 2.0
14 stars 2 forks source link

Vizgpm documentation necessary but AWOL #68

Open jar600 opened 7 years ago

jar600 commented 7 years ago

In docs/dot_commands.md there is no documentation for the .interactive_xxx commands. It looks like maybe the reader is supposed to consult the vizgpm documentation. But I can't find any vizgpm documentation, either on the web or in probcomp repositories. I see issue #41 but both links therein are broken, as is vizgpm.com. Also I see no wayback machine archive for vizgpm.com.

curlette commented 7 years ago

They're documented under Plotting > Interactive. I realized that I forgot to document that .interactive_[bar, scatter, pairplot] take a required --population parameter -- I'll create a ticket for that to remind myself to fix it.

jar398 commented 7 years ago

I wonder if we can tighten it up a bit. It says

The following dot commands work the same as their standard equivalents below, with additional capabilities for scrolling around and selecting data in the plots.

How about something like

The following dot commands take the same options as their corresponding standard equivalents below, and generate the same output, but with interactive capabilities for scrolling around and selecting data in the plots.

I.e. "work the same" and "capabilities" seem too vague to me.

I see now that the vizgpm documentation isn't needed because the dot_commands page is self-contained. Or at least I hope that's the case. (Still, very odd that vizgpm has dropped off the face of the earth.)

curlette commented 7 years ago

Sounds good to me. Noted in https://github.com/probcomp/iventure/issues/69