Change shdoc style to mkdocstrings format

未關閉
#2 0 則留言 0 個 reaction 已指派 1 人 在 GitHub 檢視

維護者通常 1 天內回覆

@JonathanTSilva 已經在處理了。

開始於 2025年8月8日。

評估

這個 Issue 還沒有評估資料。

描述

documentation

It would be interesting if shdoc generated bash documentation to be interpreted by the project documentation with mkdocstring. To do this, you might need to change the bash file comment documentation to something similar to the Google Python Style docstring.

主要語言
Shell
星號
0
分支
0
平均合併
8 小時 41 分鐘
30 天內合併 PR
9

環境準備

在 Codespaces 中開啟

在瀏覽器裡用你自己的 GitHub 帳號啟動這個專案的開發容器。

  • 沒有 Dockerfile 或 Docker Compose 檔案
  • 沒有 Pull Request 範本
  • 閱讀貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

JonathanTSilva/scriptize 的其他 Issue

查看 JonathanTSilva/scriptize 的全部 Issue

相似的 Issue

更多 Shell/Bash Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。