-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
Add passthrough of non-Markdown docs in document trimming #36091
Conversation
Maybe @timholy should review since his PR added the feature? |
bump |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks!
Just another friendly bump. This would be nice to get onto the v1.5 branch. |
I think it's fair to say this is a bug fix and backport is worth considering. So I'm adding the backport labels. @timholy @fredrikekre It'd be great if one of you can have a look at it. |
(cherry picked from commit 063525f)
* origin/master: (232 commits) Add passthrough for non-Markdown docs (JuliaLang#36091) Fix pointer to no longer assume contiguity (JuliaLang#36405) Ensure string-hashing is defined before it gets used (JuliaLang#36411) Make compilecache atomic (JuliaLang#36416) add a test for JuliaLang#30739 (JuliaLang#36395) Fix broken links in docstring of `repeat` (JuliaLang#36376) fix and de-dup cached calls to `methods_by_ftype` in compiler (JuliaLang#36404) ml-matches: skip unnecessary work, when possible (JuliaLang#36413) gf: fix some issues with the move from using a tree to a hash lookup of leaf types (JuliaLang#36413) Add news and manual entry for sincospi (JuliaLang#36403) Check axes in Array(::AbstractArray) (fixes JuliaLang#36220) (JuliaLang#36397) add versions of `code_typed` and `which` that accept tuple types (JuliaLang#36389) Fix spelling of readdir. (JuliaLang#36409) add sincospi (JuliaLang#35816) fix showing methods with unicode gensymed variable names (JuliaLang#36396) Add doctest: eachslice (JuliaLang#36386) fix documentation typo ("Ingeger") Refactor `abstract_eval` to separate out statements and values (JuliaLang#36350) fix return type of `get!` on `IdDict` (JuliaLang#36383) Allow single option with REPL.TerminalMenus (JuliaLang#36369) ...
The new extended docs feature added in #34226 defined how to trim [Julia's standard] Markdown docs. This breaks the docs retrieved in
PyPlot
since it just forwards through the original Python docs as plain-text (wrapped inBase.Docs.Text
), and there's no appropriatetrimdocs()
method for that case. There is a fallback definition of the internal_trimdocs()
, though, so it appears the restriction to specificallytrimdocs(::Markdown.MD, ::Bool)
may have been a mistake, and loosening the type on the first argument fixes the issue.I've tested this fix on master, but it should be noted that the new v1.5 beta throws the same error when using PyPlot, so this PR should probably be backported (if accepted).