clean up comments to be more concise/uniform

This commit is contained in:
Brice 2013-10-05 13:20:30 -04:00
parent 41adc30667
commit 9ff245dbdb
1 changed files with 8 additions and 8 deletions

View File

@ -2,7 +2,7 @@ require 'set'
module Jekyll module Jekyll
class Site class Site
# Handles the cleanup of a site's destination before the site is built. # Handles the cleanup of a site's destination before it is built.
class Cleaner class Cleaner
def initialize(site) def initialize(site)
@site = site @site = site
@ -15,14 +15,14 @@ module Jekyll
private private
# Private: The list of files and directories to be deleted during the cleanup process # Private: The list of files and directories to be deleted during cleanup process
# #
# Returns an Array with the file and directory paths # Returns an Array of the file and directory paths
def obsolete_files def obsolete_files
(existing_files - new_files - new_dirs + replaced_files).to_a (existing_files - new_files - new_dirs + replaced_files).to_a
end end
# Private: The list of existing files, except those included in keep_files and hidden files. # Private: The list of existing files, apart from those included in keep_files and hidden files.
# #
# Returns a Set with the file paths # Returns a Set with the file paths
def existing_files def existing_files
@ -33,7 +33,7 @@ module Jekyll
files files
end end
# Private: The list of files to be created when the site is built. # Private: The list of files to be created when site is built.
# #
# Returns a Set with the file paths # Returns a Set with the file paths
def new_files def new_files
@ -42,7 +42,7 @@ module Jekyll
files files
end end
# Private: The list of directories to be created when the site is built. # Private: The list of directories to be created when site is built.
# These are the parent directories of the files in #new_files. # These are the parent directories of the files in #new_files.
# #
# Returns a Set with the directory paths # Returns a Set with the directory paths
@ -57,7 +57,7 @@ module Jekyll
new_dirs.select { |dir| File.file?(dir) }.to_set new_dirs.select { |dir| File.file?(dir) }.to_set
end end
# Private: creates a regular expression from the config's keep_files array # Private: Creates a regular expression from the config's keep_files array
# #
# Examples # Examples
# ['.git','.svn'] creates the following regex: /\/(\.git|\/.svn)/ # ['.git','.svn'] creates the following regex: /\/(\.git|\/.svn)/
@ -70,4 +70,4 @@ module Jekyll
end end
end end
end end
end end