Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

I would like the output of help to be written in READEME. #1633

Closed
29rou opened this issue May 30, 2022 · 1 comment · Fixed by #1934
Closed

I would like the output of help to be written in READEME. #1633

29rou opened this issue May 30, 2022 · 1 comment · Fixed by #1934
Assignees
Labels
docs Documentation related

Comments

@29rou
Copy link
Member

29rou commented May 30, 2022

What's the problem this feature will solve?

This is so that those who are wondering whether to use this tool can understand how to use it at a glance. I also believe that this will encourage more people to use this tool.

Describe the solution you'd like

Describe the output of help in READEME.

Alternative Solutions

Add a man page to the documentation.

#1634

@29rou 29rou added the docs Documentation related label May 30, 2022
@29rou 29rou self-assigned this May 30, 2022
@29rou 29rou linked a pull request May 30, 2022 that will close this issue
4 tasks
@29rou 29rou pinned this issue May 30, 2022
@29rou 29rou unpinned this issue May 30, 2022
@atugushev
Copy link
Member

atugushev commented Jul 24, 2023

@29rou FYI, there is a PR (#1934) where CLI reference (help output) has been included in the pip-tools' documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
2 participants