Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reference docs don't show inherited properties #4966

Closed
birdsarah opened this issue Aug 16, 2016 · 5 comments · Fixed by #9715
Closed

Reference docs don't show inherited properties #4966

birdsarah opened this issue Aug 16, 2016 · 5 comments · Fixed by #9715

Comments

@birdsarah
Copy link
Member

@birdsarah birdsarah commented Aug 16, 2016

I noticed this comment on #4958 from @rornor.

Right. Figure that accept sizing_mode, though it does not seem to be documented http://bokeh.pydata.org/en/latest/docs/reference/plotting.html#bokeh.plotting.figure.Figure
Probably it inherits this argument from elsewhere...

If you're trying to help yourself, going to the reference docs for a specific model I'm not sure you should have to go all the way up the class hierarchy to LayoutDOM manually to see that there's a sizing_mode option.

Thoughts @bryevdv?

@bryevdv
Copy link
Member

@bryevdv bryevdv commented Aug 16, 2016

I think they should, I thought they already did. Tho I can't find the :inherited-members: directive that would trigger that in current master. It would probably go here:

https://github.com/bokeh/bokeh/blob/master/bokeh/sphinxext/bokeh_model.py#L46-L51

@bryevdv
Copy link
Member

@bryevdv bryevdv commented Oct 5, 2016

So, yes adding :inherited-members: there does the trick, but it really explodes the list for eery model and includes a lot of noise most users will never care about. So, I'd like to do this, but I'd like to enhance the sphinx extensions to be able to group members differently and better, and to have some "advanced" groupings collapsed by default.

@jhdedrick
Copy link

@jhdedrick jhdedrick commented Jan 2, 2018

I'm not sure if this should be a comment here or a new issue:
There is basically no documentation available for "sizing_mode". The "Laying out Plots and Widgets" page https://bokeh.pydata.org/en/latest/docs/user_guide/layout.html is careful to instruct the user that consistent sizing modes are important, but doesn't say which options are available nor what they do. You can find a one-line list of the legal values under "enums" https://bokeh.pydata.org/en/latest/docs/reference/core/enums.html but no info about functionality.

@bryevdv
Copy link
Member

@bryevdv bryevdv commented Jan 2, 2018

As stated above the docs for sizing_mode are down on a base class:

http://bokeh.pydata.org/en/latest/docs/reference/models/layouts.html#bokeh.models.layouts.LayoutDOM.sizing_mode

@bryevdv bryevdv added this to the short-term milestone Sep 11, 2018
@bryevdv bryevdv removed this from the short-term milestone Sep 11, 2018
@bryevdv bryevdv added this to the 2.0 milestone Feb 19, 2020
@bryevdv
Copy link
Member

@bryevdv bryevdv commented Feb 19, 2020

moving to 2.0 as a reminder to try setting full output again and seeing if the page sizes are tolerable before release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants