RFC: Add support for dynamic doc strings #20142
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MichaelHatherly
suggested changes
Jan 20, 2017
base/docs/Docs.jl
Outdated
| var = getfield(binding.mod, binding.var) | ||
| if method_exists(getdoc, (typeof(var),)) | ||
| return Base.Markdown.parse(getdoc(var)) | ||
| end |
Member
There was a problem hiding this comment.
Can be a bit shorter/clearer as
function doc(binding::Binding, sig::Type = Union{})
+ if defined(binding)
+ result = getdoc(resolve(binding), sig)
+ result === nothing || return Markdown.parse(result)
+ end
results, groups = DocStr[], MultiDoc[]with a default getdoc(obj, sig) = nothing method. Passing sig through to getdoc as well may be useful?
base/docs/Docs.jl
Outdated
| doc(object, sig::Type = Union{}) = doc(aliasof(object, typeof(object)), sig) | ||
|
|
||
| function doc(object, sig::Type = Union{}) | ||
| doc(aliasof(object, typeof(object)), sig) |
Member
There was a problem hiding this comment.
Unintentional formatting change?
tkelman
reviewed
Jan 22, 2017
| Docs.doc(binding, sig) | ||
| Returns all documentation that matches both `binding` and `sig`. | ||
Contributor
Author
|
@MichaelHatherly look good now? |
MichaelHatherly
approved these changes
Jan 24, 2017
| """ | ||
| function doc(binding::Binding, sig::Type = Union{}) | ||
| if defined(binding) | ||
| result = getdoc(resolve(binding), sig) |
Member
There was a problem hiding this comment.
Would it make sense to not call Markdown.parse here and instead just return result? That way getdocs could return a more suitable object, such as an RST object for rst-formatted python docstrings.
Contributor
Author
There was a problem hiding this comment.
Ya, that's a good call.
stevengj
reviewed
Jan 25, 2017
| """ | ||
| getdoc(x::T, sig) -> String | ||
| Return the dynamic docstring associated with object `x`, or `nothing` to use |
Member
There was a problem hiding this comment.
The docstring doesn't explain what the sig argument is for.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Useful for eg JuliaPy/PyCall.jl#46.
Allows instances of the same type to have different docstrings which can only be determined at runtime. Useful for interlanguage support where the same Julia type (eg
PyObject) corresponds to different types in the guest language that might have different docstrings.