Skip to content

Commit

Permalink
improve man pages
Browse files Browse the repository at this point in the history
* man/ruby.1, man/erb.1, man/goruby.1, man/irb.1:
  fix document title formatting and volume name,
  improve "REPORTING BUGS" section: fix mdoc formatting error
  (wrong macro for bullet list items), small rewordings.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@58411 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
  • Loading branch information
stomar committed Apr 20, 2017
1 parent 7604723 commit cafa438
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 18 deletions.
12 changes: 7 additions & 5 deletions man/erb.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\"Ruby is copyrighted by Yukihiro Matsumoto <[email protected]>.
.Dd November 15, 2012
.Dt ERB(1) "" "Ruby Programmers Reference Guide"
.Dt ERB \&1 "Ruby Programmer's Reference Guide"
.Os UNIX
.Sh NAME
.Nm erb
Expand Down Expand Up @@ -143,15 +143,17 @@ class.
.Pp
.Sh REPORTING BUGS
.Bl -bullet
.Li Security vulnerabilities should be reported via an email to
.Aq [email protected] .
.It
Security vulnerabilities should be reported via an email to
.Mt [email protected] .
Reported problems will be published after being fixed.
.Pp
.Li And you can report other bugs and feature requests via the
.It
Other bugs and feature requests can be reported via the
Ruby Issue Tracking System
.Pq Lk https://bugs.ruby-lang.org/ .
Do not report security vulnerabilities
via the system because it publishes the vulnerabilities immediately.
via this system because it publishes the vulnerabilities immediately.
.El
.Sh AUTHORS
Written by Masatoshi SEKI.
2 changes: 1 addition & 1 deletion man/goruby.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\"Ruby is copyrighted by Yukihiro Matsumoto <[email protected]>.
.Dd November 15, 2012
.Dt GORUBY(1) "" "Ruby Programmers Reference Guide"
.Dt GORUBY \&1 "Ruby Programmer's Reference Guide"
.Os UNIX
.Sh NAME
.Nm goruby
Expand Down
12 changes: 7 additions & 5 deletions man/irb.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\"Ruby is copyrighted by Yukihiro Matsumoto <[email protected]>.
.Dd November 15, 2012
.Dt IRB(1) "" "Ruby Programmers Reference Guide"
.Dt IRB \&1 "Ruby Programmer's Reference Guide"
.Os UNIX
.Sh NAME
.Nm irb
Expand Down Expand Up @@ -159,15 +159,17 @@ Personal irb initialization.
.Pp
.Sh REPORTING BUGS
.Bl -bullet
.Li Security vulnerabilities should be reported via an email to
.Aq [email protected] .
.It
Security vulnerabilities should be reported via an email to
.Mt [email protected] .
Reported problems will be published after being fixed.
.Pp
.Li And you can report other bugs and feature requests via the
.It
Other bugs and feature requests can be reported via the
Ruby Issue Tracking System
.Pq Lk https://bugs.ruby-lang.org/ .
Do not report security vulnerabilities
via the system because it publishes the vulnerabilities immediately.
via this system because it publishes the vulnerabilities immediately.
.El
.Sh AUTHORS
Written by Keiju ISHITSUKA.
15 changes: 8 additions & 7 deletions man/ruby.1
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
.\"Ruby is copyrighted by Yukihiro Matsumoto <[email protected]>.
.Dd October 31, 2015
.Dt RUBY(1) "" "Ruby Programmers Reference Guide"
.\".Dt RUBY 1
.Dt RUBY \&1 "Ruby Programmer's Reference Guide"
.Os UNIX
.Sh NAME
.Nm ruby
Expand Down Expand Up @@ -641,15 +640,17 @@ Comprehensive catalog of Ruby libraries.
.Pp
.Sh REPORTING BUGS
.Bl -bullet
.Li Security vulnerabilities should be reported via an email to
.Aq [email protected] .
Reported problems will be published after they've been fixed.
.It
Security vulnerabilities should be reported via an email to
.Mt [email protected] .
Reported problems will be published after being fixed.
.Pp
.Li And you can report other bugs and feature requests via the
.It
Other bugs and feature requests can be reported via the
Ruby Issue Tracking System
.Pq Lk https://bugs.ruby-lang.org/ .
Do not report security vulnerabilities
via the system because it publishes the vulnerabilities immediately.
via this system because it publishes the vulnerabilities immediately.
.El
.Sh AUTHORS
Ruby is designed and implemented by
Expand Down

0 comments on commit cafa438

Please sign in to comment.