Man page needs more attention #769

Closed
kyrylo opened this Issue Dec 2, 2012 · 18 comments

Projects

None yet

5 participants

@kyrylo
Member
kyrylo commented Dec 2, 2012

No description provided.

@rking
Collaborator
rking commented Dec 4, 2012

Guys. I am hungry for ~/.pry_historys.

What I want to do is run a big scan on them and figure out which commands and what Ruby we're running in them. I can do this for my own, but it'd be better balanced if I got yours. The man page would be one thing that would benefit from this knowledge.

mail -s $USER notafraidtoshareapryhistory@sharpsaw.org < ~/.pry_history

@andrewvos
@Asher-
@banister
@ConradIrwin
@cout
@ddd
@epitron
@kyrylo
@fowlmouth
@Mon-Ouie
@rf-
@robgleeson
@sent-hil
@swarley
@YorickPeterse

@rking
Collaborator
rking commented Dec 4, 2012

Github trynna not let me tag errbody.

@rf-
@robgleeson
@sent-hil
@swarley
@YorickPeterse

@sent-hil
sent-hil commented Dec 4, 2012

Done!

@swarley
swarley commented Dec 15, 2012

Sent mine as well.

@kyrylo
Member
kyrylo commented Dec 15, 2012

I heard @rondale-sc can help us with this issue (it was his idea to add the man page).

@rondale-sc

@rking @kyrylo I'd love to help. Have you compiled a list of top commands from the .pry_history's that you've collected? If you'd like me to do that I can, just hit me with the info. ^_^

@swarley
swarley commented Dec 15, 2012

Ill gladly help as well, just remind me when you see me on IRC.
On Dec 15, 2012 4:05 PM, "Jonathan" notifications@github.com wrote:

@rking https://github.com/rking @kyrylo https://github.com/kyrylo I'd
love to help. Have you compiled a list of top commands from the
.pry_history's that you've collected? If you'd like me to do that I can,
just hit me with the info. ^_^


Reply to this email directly or view it on GitHubhttps://github.com/pry/pry/issues/769#issuecomment-11410395.

@rking
Collaborator
rking commented Dec 15, 2012

If you want to add a little DRY tool to maybe include help output and loop over all commands' --help, then add that to the gem process, in the right format, that would be a nice start!

Jonathan notifications@github.com wrote:

@rking @kyrylo I'd love to help. Have you compiled a list of top commands from the .pry_history's that you've collected? If you'd like me to do that I can, just hit me with the info. ^_^


Reply to this email directly or view it on GitHub:
#769 (comment)

@rondale-sc

Updated the man page with a list of all Pry.commands. Parsed result of Pry.commands using https://gist.github.com/4315706. Not sure if that's what we're after, but maybe a place to start.

rondale-sc@0a2b078

I also wrote a blog on creating man-pages back when I originally created the man page for pry: http://jonathan-jackson.net/man-and-ruby.html.

I'm not sure if the pry commands belong in man(1). But I'm not sure where else they'd go.

Sections are broken down like so (http://en.wikipedia.org/wiki/Man_page):

  1. General commands
  2. System calls
  3. Library functions, covering in particular the C standard library
  4. Special files (usually devices, those found in /dev) and drivers
  5. File formats and conventions
  6. Games and screensavers
  7. Miscellanea
  8. System administration commands and daemons
@rking
Collaborator
rking commented Dec 18, 2012

@rondale-sc - Looks like a nice start!

  1. Some of the formatting has some extra blank lines, it seems.
  2. Can you rig up a process to autogenerate this? E.g. IMO it should be a dependency of the 'gemspec' Rake task, so we don't forget to update it.
  3. There are some other things I want to do, one is analyze the ~/.pry_historys and write an intro section for the most-common use patterns.

Thanks! (Or am I just saying that because I'm intimidated by your Gravatar pointing at me menacingly?)

@rondale-sc
  • I'll work on the formatting.
  • With regards to the rake task. I'll put something together.
  • Where are all the ~/.pry_history's?

And the picture isn't really that menacing, ^_~

@rondale-sc

Here's a start: https://github.com/rondale-sc/generate_pry_man

If any of you have suggestions for other things that might fit into the man page, be sure to take a look at the template file with the .erb extension. Now is a good time to add some stuff.

Thanks.

@ghost
ghost commented Dec 20, 2012

@rondale-sc no need for those accessors ;-) Implement "close" on your class, and get rid of obj.ronn_file.close.

@ghost
ghost commented Dec 20, 2012

@rondale-sc oops, just get rid of the accessors, you close in generate_all.

@rondale-sc

@robgleeson I'm using the accessors as readers. I could change them, but if I remove them I'll need to reference the variables themselves.

I'll take a look again later, and probably add a few unit tests.

@ghost
ghost commented Dec 20, 2012

@rondale-sc generally, it is better to keep state private and provide an interface that operates upon that state. For this, though, I don't think it really matters.

@rondale-sc

@robgleeson That's a good point. Unfortunately, I didn't test drive this so I was kinda willy-nilly with state. I'm going to add a test or two and refactor later.

@kyrylo
Member
kyrylo commented Dec 11, 2013

We decided to remove the man page completely.

@kyrylo kyrylo closed this Dec 11, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment