donnemartin/gitsome

Provide man pages

Open

#62 opened on Jun 8, 2016

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (7,494 stars) (476 forks)batch import
feature-requesthelp wanted

Description

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.

Contributor guide

Tech stack
pythonshell
Domain
clidocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of man page formatFamiliarity with Python packaging
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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.