llnl / llnl/py-hostlist

man page

Open
#13 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
7
Forks
2
PR merge metrics
No merged PRs in 30d

Description

We will need to write a man page. It doesn't appear that the lua-hostlist repo has a man page. Running man hostlist on an LC system turns up perl documentation... I have no idea where that code comes from.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the hostlist command entry point and its existing usage or help text. Use that behavior to outline a man page for the utility, then verify that man hostlist resolves to the project documentation on an LC system.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.