Documentation confusion

Community Support
1

Hello there,
first of all I’d like to say that I’m very thrilled about Bokeh. It’s really something that I’m going to use.
However I find the documentation a little hard to search.
A simple example : the function figure from the bokeh.plotting module isn’t really documented, or I can’t find it.
I see a lot of parameters in the tutorials, e.g. x_range, plot_width, …, but I can’t find any of them documented in the bokeh.plotting reference page. This seems weird.

I find myself having to look into the source code. This is not what I would expect.

This makes using bokeh harder than necessary. I hope this is just a temporary problem ?

Regards,

Bart

2

Hi,

This has already been addressed, but is not in a full release yet. But you can see the latest dev build docs here:

  http://bokeh.pydata.org/en/dev/docs/reference/plotting.html

Beyond those options, since Figure is a subclass of Plot, it also accepts all the properties that Plot does:

  http://bokeh.pydata.org/en/dev/docs/reference/models/plots.html#bokeh.models.plots.Plot

We have talked about having the docs show all available properties, even ones from subclasses, but that would make some of the refguide pages absolutely explode in length. Not sure what a good compromise would be, but any suggestions welcome.

Thanks,

Bryan

···

On Dec 12, 2016, at 2:44 PM, [email protected] wrote:

Hello there,

first of all I'd like to say that I'm very thrilled about Bokeh. It's really something that I'm going to use.
However I find the documentation a little hard to search.

A simple example : the function figure from the bokeh.plotting module isn't really documented, or I can't find it.
I see a lot of parameters in the tutorials, e.g. x_range, plot_width, ..., but I can't find any of them documented in the bokeh.plotting reference page. This seems weird.

I find myself having to look into the source code. This is not what I would expect.

This makes using bokeh harder than necessary. I hope this is just a temporary problem ?

Regards,

Bart

--
You received this message because you are subscribed to the Google Groups "Bokeh Discussion - Public" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit https://groups.google.com/a/continuum.io/d/msgid/bokeh/02113716-3ea4-42e7-965d-5bdb58656f5c%40continuum.io\.
For more options, visit https://groups.google.com/a/continuum.io/d/optout\.

3

Thanks a lot. This is much more usable !

Regards,

Bart

···

On Monday, December 12, 2016 at 9:45:16 PM UTC+1, [email protected] wrote:

Hello there,
first of all I’d like to say that I’m very thrilled about Bokeh. It’s really something that I’m going to use.
However I find the documentation a little hard to search.
A simple example : the function figure from the bokeh.plotting module isn’t really documented, or I can’t find it.
I see a lot of parameters in the tutorials, e.g. x_range, plot_width, …, but I can’t find any of them documented in the bokeh.plotting reference page. This seems weird.

I find myself having to look into the source code. This is not what I would expect.

This makes using bokeh harder than necessary. I hope this is just a temporary problem ?

Regards,

Bart