JuliaDocs / JuliaDocs/DocStringExtensions.jl
Provide BODY
Open
Nobody has claimed this yet.
Status: Available
Type: Feature
- Dominant language
- Julia
- Stars
- 126
- Forks
- 35
- PR merge metrics
- No merged PRs in 30d
Description
Sometimes, short functions are best documented by their full definition (and sometimes I'm just lazy). It would be nice if $(BODY) was replaced with log(p / (1 - p)).
""" Logistic regression, $(BODY) """
logit(p) = log(p / (1 - p))
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 in the issue. Start by locating the docstring substitution or interpolation entry point for existing placeholders, then use the Julia example as the expected case; done means $(BODY) expands to the function body in the generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100