JuliaDocs/Documenter.jl

Add support for 'Filter' in `@index`

Open

#1,877 opened on Jul 14, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Julia (513 forks)batch import
Type: Enhancementhelp wanted

Repository metrics

Stars
 (910 stars)
PR merge metrics
 (Avg merge 16d 9h) (3 merged PRs in 30d)

Description

A great feature of @autodocs is Filter. So, I can do for example:

```@autodocs
Modules = [CellArrays]
Order   = [:type]
Filter = t -> typeof(t) !== CellArray

It seems to me natural to list first what @autodocs will show. Thus, in analogy, I would be tempted to do the selection for @index just the same way as for @autodocs:

```@index
Modules = [CellArrays]
Order = [:type]
Filter = t -> typeof(t) !== CellArray

However, to my surprise Filter is not supported for @index. Is there any particular reason for this or could this be added?

Contributor guide

Research direction
Examine the implementation of the `Filter` keyword in `@autodocs` within the Documenter.jl source code, then replicate the same parsing and filtering logic for the `@index` block.
Tech stack
None
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
JuliaDocumenter.jl basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70