JuliaDocs/Documenter.jl

Generalize the at-example line hiding

Open

#2,025 创建于 2023年1月25日

在 GitHub 查看
 (0 评论) (2 反应) (0 负责人)Julia (513 fork)batch import
Type: Enhancementhelp wanted

仓库指标

Star
 (910 star)
PR 合并指标
 (平均合并 16天 9小时) (30 天内合并 3 个 PR)

描述

Currently, you can only hide lines that end with # hide. We could generalize it by allowing the user to pass a hide option to the block which should be a regex (or an array of regexes) that we then occursin against the lines.Potential use cases:

  • Hiding JuliaFormatter #! format: off with e.g. a r"^#! format:" regex.
  • Filtering out comments with r"^#
```@example my-block; hide = r"^#! format:"
#! format: off
weirdly_formatted_code_that_I_want_to_keep_that_way(...)
#! format: on
```

X-ref: https://discourse.julialang.org/t/interaction-between-logging-jl-juliaformatter-jl-and-documenter-jl/93504

贡献者指南

研究方向
在 Documenter.jl 的源代码中搜索当前的行隐藏实现，很可能在处理 @example 代码块的文件中。理解以 '# hide' 结尾的行是如何被排除的。然后，修改代码块解析逻辑，使其接受一个可选的 'hide' 参数，该参数可以是正则表达式或正则表达式数组。使用 occursin 函数来匹配每一行。确保更改向后兼容，并相应更新文档。
技术栈
无
领域
documentationbackend
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
新近可参与
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
JuliaRegex
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65