Merge pull request #26 from colby-swandale/improve-chdir-doc

yuki24 · web-flow · commit 89a83a0a9631 · 2018-12-31T13:30:37.000Z
improve the documentation of FileUtils.cd
diff --git a/lib/fileutils.rb b/lib/fileutils.rb
@@ -114,12 +114,14 @@ def pwd
   #
   # Changes the current directory to the directory +dir+.
   #
-  # If this method is called with block, resumes to the old
-  # working directory after the block execution finished.
+  # If this method is called with block, resumes to the previous
+  # working directory after the block execution has finished.
   #
-  #   FileUtils.cd('/', :verbose => true)   # chdir and report it
+  #   FileUtils.cd('/')  # change directory
   #
-  #   FileUtils.cd('/') do  # chdir
+  #   FileUtils.cd('/', :verbose => true)   # change directory and report it
+  #
+  #   FileUtils.cd('/') do  # change directory
   #     # ...               # do something
   #   end                   # return to original directory
   #

Original file line number	Diff line number	Diff line change
`@@ -114,12 +114,14 @@ def pwd`
`114`	`114`	`#`
`115`	`115`	`# Changes the current directory to the directory +dir+.`
`116`	`116`	`#`
`117`		`- # If this method is called with block, resumes to the old`
`118`		`- # working directory after the block execution finished.`
	`117`	`+ # If this method is called with block, resumes to the previous`
	`118`	`+ # working directory after the block execution has finished.`
`119`	`119`	`#`
`120`		`- # FileUtils.cd('/', :verbose => true) # chdir and report it`
	`120`	`+ # FileUtils.cd('/') # change directory`
`121`	`121`	`#`
`122`		`- # FileUtils.cd('/') do # chdir`
	`122`	`+ # FileUtils.cd('/', :verbose => true) # change directory and report it`
	`123`	`+ #`
	`124`	`+ # FileUtils.cd('/') do # change directory`
`123`	`125`	`# # ... # do something`
`124`	`126`	`# end # return to original directory`
`125`	`127`	`#`