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
Incorporate GeneratePryMan into pry. #785
Conversation
Pry commands were listed using Pry version 0.9.10 on Ruby 1.9.3
Renamed the method copy_to_man_dir to move_to_man_dir. And changed the Rakefile to call by new name. This clears out 3 additional files per run.
Also exclude tests from running in jruby since ronn has a dependency on rdiscount (a c-extension).
thanks, how do i install the man page? |
Merging your commit causes test failures, can u fix these please? https://travis-ci.org/pry/pry/builds/3900587 :) |
nm, it was reverted, fix the tests and we'll remerge at that point :) |
Sure I'll take a look. I thought travis-ci was passing on the most recent commit though. Weird. |
btw @rondale-sc we need to figure out a better way of excluding JRuby from these tests. The |
I'll look at this as soon as I get some time. @rf- I'm not sure the correct way. With rspec it'd be something like
but with bacon I wasn't able to use implicit filters (https://www.relishapp.com/rspec/rspec-core/v/2-2/docs/filtering/implicit-filters). @banister I'll have to figure out about the tests when I can properly sit down at my computer. Sorry for the failing tests. |
I've included the class and associated files into a directory nested inside the man directory (see: rondale-sc@28a43fe)
There is now a new rake task that calls this class called generate_man_page in the top level rake namespace. (see: rondale-sc@d47f3e8)
I ran the task to update the man-pages (see: rondale-sc@d47f3e8)
The idea here is to make sure the man-page is filled with useful information. If you want to alter the man page it's really simple now:
Adding a section
man/generate_pry_man/templates/pry.1.erb
:section_name
with the name of your section.rake generate_man_page
Editing a section
man/templates/man_section/<name_of_section_you_want_to_edit>.md
Caveats
.roff
files..roff
and.html
files and then manually inspect them for correctness. Once that's done you're tests will pass again.Alright I think that's enough. Let me know if you'd like me to change anything, or if I need to restructure somehow.
Also, many thanks to irc#pry people for helping!