Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Docstrings need to embed parameters in backticks

已关闭
#72 2 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
30/100
Issue 类型
文档
描述清晰度
需要澄清
活跃度
停滞
技术栈
julia
领域
documentation

调研方向

首先定位生成 OpenAPI 参数 docstrings 的代码,并复现 issue 中所示的 markdown 渲染结果。检查包含下划线的参数名称是如何输出的;完成的标准是,这些名称在生成的文档中按字面渲染,而不会被 markdown 解析。

由索引模型根据 Issue 内容生成。

描述

stale

Otherwise, underscores get parsed as markdown, leading to:

Screenshot 2024-04-14 at 9 23 19 PM
主要语言
Julia
星标
56
派生
16
平均合并
1 天 24 分钟
30 天内合并 PR
15

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

JuliaComputing/OpenAPI.jl 的其他 Issue

查看 JuliaComputing/OpenAPI.jl 的全部 Issue

相似的 Issue

更多 Julia Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。