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

Developer Manual section documenting plotting API #523

Closed
wants to merge 1 commit into from

Conversation

jlstevens
Copy link
Contributor

It is time for us to slow down the changes to the internal plotting API so we can document the plotting system. The purpose of this proposed documentation is to help explain how a plotting class is structured to allow new developers to extend HoloViews themselves.

Although documenting the plotting system is the biggest job and highest priority, we will probably need a section on adding new elements as well in order for this to be useful. I imagine this documentation will serve as a guide to the core API which is already documented in the reference manual.

There is a fair bit of work to do here but I don't think we can postpone it any longer!

@jlstevens jlstevens added the type: docs Related to the documentation and examples label Feb 27, 2016
@jlstevens jlstevens self-assigned this Feb 27, 2016
@jlstevens jlstevens modified the milestones: v1.5.0, 1.4.4 Feb 27, 2016
@jlstevens
Copy link
Contributor Author

I'm making some progress and will have new commits soon. I just wanted to mention the problem I had described in issue #525. Should I make use of such links and assume this problem can be fixed shortly or should I avoid them for now?

@jbednar
Copy link
Member

jbednar commented Feb 28, 2016

I'd go ahead and use the links, because even if they don't work, they are at least a very precise record of what entity is being discussed. And they may work someday!

@jlstevens
Copy link
Contributor Author

Thankfully, Philipp managed to implement a fix pretty quickly! #525

@philippjfr philippjfr modified the milestones: v1.5.0, 1.4.4 Apr 20, 2016
@philippjfr philippjfr modified the milestones: v1.6.0, v1.5.0 Apr 29, 2016
@philippjfr
Copy link
Member

Anything ever happen here? I started a some documentation about the renderer and plotting API, which I hope to get merged before 1.7, but it seems like this PR isn't going anywhere. Can I close?

@jlstevens
Copy link
Contributor Author

Yes, I think you can close.

Generally, the idea now is to push this kind of material to contrib. If you have a notebook explaining these topics, it would be good to submit to contrib.

@philippjfr philippjfr closed this Jan 4, 2017
@jlstevens jlstevens deleted the plotting_docs branch August 21, 2017 21:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Related to the documentation and examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants