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

Re-enable custom docstring types. #15428

Merged

Conversation

MichaelHatherly
Copy link
Member

Custom docstring support was lost in #15266. This remedies the regressions introduced there as well as fixing Text and HTML display signatures that were also broken, likely when Function
became an abstract type, and had gone unnoticed.

Also adds a test case based on PyPlot to hopefully avoid future regressions.

Fixes #15424.

@stevengj, I've been having trouble loading PyPlot and encountered the following error

LLVM ERROR: Program used external function 'julia_getindex_23100' which could not be resolved!

during pre-compilation, which doesn't seem to be related to the docsystem issue as far as I can see. Would you be able to confirm locally whether this pr fixes PyPlot? Thanks.

Custom docstring support was lost in JuliaLang#15266. This remedies the
regressions introduced there as well as fixing `Text` and `HTML`
display signatures that were also broken, likely when `Function`
became an abstract type, and had gone unnoticed.

Also adds a test case based on PyPlot to hopefully avoid future regressions.

Fixes JuliaLang#15424.
@MichaelHatherly MichaelHatherly added the docsystem The documentation building system label Mar 9, 2016
@stevengj
Copy link
Member

stevengj commented Mar 9, 2016

@MichaelHatherly, I've just tried PyCall on the latest master and got a similar error LLVM ERROR: Program used external function '_julia_Type_22899' which could not be resolved!. This seems like an unrelated Julia bug that I'll have to bisect.

For now, I think your home-brewed LazyHelp skeleton should be enough to close #15424.

@yuyichao
Copy link
Contributor

yuyichao commented Mar 9, 2016

The PyCall failure is #15300 (comment)

@MichaelHatherly
Copy link
Member Author

Good, not just me then. Thanks for checking!

@MichaelHatherly
Copy link
Member Author

Thanks @yuyichao. Looks like PyPlot's docstrings are working fine now with this pr.

MichaelHatherly added a commit that referenced this pull request Mar 10, 2016
@MichaelHatherly MichaelHatherly merged commit f253526 into JuliaLang:master Mar 10, 2016
@MichaelHatherly MichaelHatherly deleted the mh/custom-docstrings branch March 10, 2016 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docsystem The documentation building system
Projects
None yet
Development

Successfully merging this pull request may close these issues.

support for non-markdown docstrings is broken?
3 participants