question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Needs a dedicated man page

See original GitHub issue

So, pipenv ships with a man page that can be opened with pipenv --man, but that man page has a few issues regarding usability, because it is just built from the sphinx docs.

  1. I don’t need any information about how to install pipenv. I already have it. (I don’t need user testimonials either.)
  2. It doesn’t list the general cli usage at the top, which is one of the most useful sections.
  3. The docs have a couple of links, which don’t convert to a man page.
  4. Example files are good, but more useful at the bottom
  5. More, that I don’t care to list right now.

Basically, it’s not really a man page. It’s a user guide in form of a man page. That said, it’s still good that there is something you can access (without an internet connection), but in the current state it’s pretty lackluster. Pipenv needs a dedicated man page imho.

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Comments:15 (9 by maintainers)

github_iconTop GitHub Comments

2reactions
techalchemycommented, Jun 22, 2018

I don’t think there’s anything wrong with big man pages, it’s pretty common. And it’s not that common to split things up. As a user of man pages I’d probably find that annoying

1reaction
kennethreitzcommented, Nov 22, 2017

we can’t ship a proper man page that works with man, i’ve looked into it heavily.

we can improve the “man” functionality, but i’d rather just remove it.

On Tue, Nov 21, 2017 at 8:30 PM, FichteFoll notifications@github.com wrote:

What does this have to do with pip?

— You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHub https://github.com/kennethreitz/pipenv/issues/1100#issuecomment-346215330, or mute the thread https://github.com/notifications/unsubscribe-auth/AAHUVTi5COoAUjf4Qy3NIcRgt_XFZ5WSks5s43lLgaJpZM4Qjk5U .

Read more comments on GitHub >

github_iconTop Results From Across the Web

man(1) - Linux manual page - man7.org
man is the system's manual pager. Each page argument given to man is normally the name of a program, utility or function. The...
Read more >
A Dedicated Man (Inspector Banks Mysteries) - Amazon.com
A dedicated man is dead in the wild outdoors—a former university professor, wealthy historian and archaeologist who loved his adopted village.
Read more >
Top 5 Linux man command options for browsing man pages
My five favorite options for getting the most from the man command. ... a huge repository of information is not something any sysadmin...
Read more >
Mastering Linux Man Pages - A Definitive Guide - YouTube
Read the full blog post here:https://www.linuxtrainingacademy.com/manDo you want to know where to find the answer to just about any Linux ...
Read more >
What are man pages? - Liquid Web
A man page is a piece of documentation that is distributed and read digitally. Almost every package you install on a UNIX-based OS...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found