catfood.functions.format.github

将传入的字符统一为某种 GitHub 上的格式。

catfood.functions.format.github.IssueNumber(string: str | int | None) → str | None

从给定的字符串中获取 Issue 或 PR 的编号。

参数:

string (str | int | None) -- 给定的输入内容

返回:

返回字符串的编号，获取失败返回 None

返回类型:

str | None

catfood.functions.format.github.ResolvesIssue(string: str | int | None, keyword: str = 'Resolves') → str | None

将给定的字符串格式化为 GitHub PR 的 Resolves Issue 格式

GitHub Docs: https://docs.github.com/zh/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword

参数:

• string (str | int | None) -- 给定的输入内容

• keyword (str) -- 链接议题时使用的关键词

返回:

格式化成功返回字符串结果，失败返回 None

返回类型:

str | None