JuliaDocs / JuliaDocs/DocStringExtensions.jl
Feature request: option to override template in specific case
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 override a set template for a particular docstring?
In particular, my template involves $TYPEDSIGNATURES, and in a couple of exceptional cases, I would rather omit those in favor of a more curated and brief list. Is it possible to do this?
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 file or test is identified in the issue; begin by locating the template and docstring rendering entry points in DocStringExtensions.jl. Define how a particular docstring can override the default template, then verify that exceptional docstrings can omit $TYPEDSIGNATURES without changing the default 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
- 35/100