Add brief documentation comments for Homesick and Homesick::Actions

This commit is contained in:
Nicolas McCurdy
2014-01-04 22:46:44 -05:00
parent 12244abb56
commit 8f634b9d07
3 changed files with 2 additions and 3 deletions

View File

@@ -1,6 +1,7 @@
# -*- encoding : utf-8 -*- # -*- encoding : utf-8 -*-
require 'thor' require 'thor'
# Homesick's command line interface (with some helper methods)
class Homesick < Thor class Homesick < Thor
autoload :Shell, 'homesick/shell' autoload :Shell, 'homesick/shell'
autoload :Actions, 'homesick/actions' autoload :Actions, 'homesick/actions'

View File

@@ -1,5 +1,6 @@
# -*- encoding : utf-8 -*- # -*- encoding : utf-8 -*-
class Homesick class Homesick
# Git-related and file-related helper methods for the Homesick class
module Actions module Actions
# TODO: move this to be more like thor's template, empty_directory, etc # TODO: move this to be more like thor's template, empty_directory, etc
def git_clone(repo, config = {}) def git_clone(repo, config = {})

View File

@@ -8,9 +8,6 @@ ClassLength:
CyclomaticComplexity: CyclomaticComplexity:
Max: 16 Max: 16
Documentation:
Enabled: false
Eval: Eval:
Enabled: false Enabled: false