JuliaDocs / JuliaDocs/DocStringExtensions.jl
Feature Request: Add DocStringExtensions.PUBLIC
Open
Nobody has claimed this yet.
up for grabs
- Dominant language
- Julia
- Stars
- 126
- Forks
- 35
- PR merge metrics
- No merged PRs in 30d
Description
Is there any plan for a DocStringExtensions.PUBLIC which functions like DocStringExtensions.EXPORTS,
but includes names marked by the new public keyword?
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
Start by locating the implementation of DocStringExtensions.EXPORTS and review how Julia's public keyword marks names. Determine where a matching DocStringExtensions.PUBLIC extension should be defined, then add coverage showing that it includes public names while preserving the expected EXPORTS behavior. Done means PUBLIC works as described in the issue.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100