[DOC] Beautify links and formats

ruby · Jul 3, 2024 · 70f7167 · 70f7167
1 parent 92ce99f
commit 70f7167
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 15 deletions.
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -4,10 +4,10 @@ Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
+   notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
-notice, this list of conditions and the following disclaimer in the
-documentation and/or other materials provided with the distribution.
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

diff --git a/README.md b/README.md
@@ -3,11 +3,11 @@
 This module manipulates strings according to the word parsing rules
 of the UNIX Bourne shell.
 
-The shellwords() function was originally a port of shellwords.pl,
-but modified to conform to the Shell & Utilities volume of the IEEE
-Std 1003.1-2008, 2016 Edition [1].
+The `shellwords()` function was originally a port of shellwords.pl,
+but modified to conform to [the Shell & Utilities volume of the IEEE
+Std 1003.1-2008, 2016 Edition].
 
-[1] [IEEE Std 1003.1-2008, 2016 Edition, the Shell & Utilities volume](http://pubs.opengroup.org/onlinepubs/9699919799/utilities/contents.html)
+[the Shell & Utilities volume of the IEEE Std 1003.1-2008, 2016 Edition]: http://pubs.opengroup.org/onlinepubs/9699919799/utilities/contents.html
 
 ## Installation
 
@@ -43,4 +43,3 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/shellwords.
-
diff --git a/lib/shellwords.rb b/lib/shellwords.rb
@@ -5,9 +5,9 @@
 # This module manipulates strings according to the word parsing rules
 # of the UNIX Bourne shell.
 #
-# The shellwords() function was originally a port of shellwords.pl,
-# but modified to conform to the Shell & Utilities volume of the IEEE
-# Std 1003.1-2008, 2016 Edition [1].
+# The <tt>shellwords()</tt> function was originally a port of shellwords.pl, but
+# modified to conform to {the Shell & Utilities volume of the IEEE Std 1003.1-2008, 2016
+# Edition}[http://pubs.opengroup.org/onlinepubs/9699919799/utilities/contents.html]
 #
 # === Usage
 #
@@ -62,10 +62,6 @@
 #
 # === Contact
 # * Akinori MUSHA <knu@iDaemons.org> (current maintainer)
-#
-# === Resources
-#
-# 1: {IEEE Std 1003.1-2008, 2016 Edition, the Shell & Utilities volume}[http://pubs.opengroup.org/onlinepubs/9699919799/utilities/contents.html]
 
 module Shellwords
   # The version number string.