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

docstring refactoring in figure factory #1837

Merged
merged 8 commits into from
Nov 11, 2019
Merged

docstring refactoring in figure factory #1837

merged 8 commits into from
Nov 11, 2019

Conversation

emmanuelle
Copy link
Contributor

Goals

  • update docstring iplot --> fig.show()
  • format code blocks so that they render nicely (syntax highlighting) in API ref

image

Note that the >>> do not prevent pasting in a notebook cell, jupyter know how to handle them.

I'll work through the list of figure factories but I wanted to open this first as WIP for the sake of discussing this update.

@emmanuelle
Copy link
Contributor Author

emmanuelle commented Nov 1, 2019

@nicolaskruchten @jonmmease ideally we would include this in the release, are you fine with this change (adding the >>>) ?

@emmanuelle emmanuelle added this to the v4.3.0 milestone Nov 1, 2019
@nicolaskruchten
Copy link
Contributor

I’m fine with this whole class of change so feel free to merge these types of doc string PRs at will unless you’re concerned about something and want input!

@emmanuelle
Copy link
Contributor Author

ok thanks!

@emmanuelle emmanuelle changed the title [WIP] docstring refactoring in figure factory docstring refactoring in figure factory Nov 11, 2019
@jonmmease
Copy link
Contributor

looks great to me! 💃

@emmanuelle emmanuelle merged commit cf168ed into master Nov 11, 2019
@nicolaskruchten nicolaskruchten mentioned this pull request Nov 12, 2019
@emmanuelle emmanuelle deleted the docstring branch December 2, 2019 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants