donnemartin/gitsome

Provide man pages

Open

#62 建立於 2016年6月8日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)Python (7,494 star) (476 fork)batch import
feature-requesthelp wanted

描述

At the moment help can be got through --help. This is fine but not quite as intuitive as it could be: it is customary, that help can also be invoked though gh help|--help|-h <command>, gh <command> --help|-h and man gh <command>. Usually also man pages are used as default, so that using the help commands or switches would merely open the man page.

貢獻者指南

技術棧
pythonshell
領域
clidocumentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic knowledge of man page formatFamiliarity with Python packaging
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
The issue requests adding man pages for the gitsome CLI tool. To implement, first research how other Python CLI projects generate man pages, e.g., using help2man or manually writing man page files in a markdown like format and converting with pandoc. Consider integrating man page generation into the existing build process, perhaps by extending the setup.py or adding a script. The existing help output can serve as a base for content, but man pages should follow the standard structure (NAME, SYNOPSIS, DESCRIPTION, OPTIONS, etc.). Look at the repository's current documentation structure and any existing documentation generation tools.