Skip to content
This repository

Man page needs more attention #769

Closed
kyrylo opened this Issue December 02, 2012 · 18 comments

6 participants

Kyrylo Silin ☈king sent hil Matt Carey Jonathan
Kyrylo Silin
Collaborator

No description provided.

☈king
Collaborator

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

☈king
Collaborator

Github trynna not let me tag errbody.

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

sent hil

Done!

Matt Carey

Sent mine as well.

Kyrylo Silin
Collaborator

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

Jonathan

@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. ^_^

Matt Carey
☈king
Collaborator
Jonathan

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
☈king
Collaborator

@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?)

Jonathan
  • 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, ^_~

Jonathan

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.

Owner

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

Owner

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

Jonathan

@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.

Owner

@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.

Jonathan

@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 Silin
Collaborator

We decided to remove the man page completely.

Kyrylo Silin kyrylo closed this December 11, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.