JuliaDocs / JuliaDocs/DocStringExtensions.jl
FUNCTIONNAME inside a function that generates the docstring
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 126
- Forks
- 35
- PR merge metrics
- No merged PRs in 30d
Description
Is it possible to get FUNCTIONNAME to work inside a function that generates the docstring? Something similar to
function gen_docstring()
"""
$(FUNCTIONNAME)(x)
"""
end
@doc gen_docstring()
function f(x)
x
end
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No source file or test is named. Start by tracing FUNCTIONNAME in the gen_docstring() and @doc example, then inspect how the enclosing function f(x) is represented during docstring generation. Done means determining whether FUNCTIONNAME can resolve to f and documenting or implementing the supported behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100