Skip to content

Commit

Permalink
More readable documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Bubujka committed Jan 29, 2012
1 parent a06bc00 commit 4b8af2a
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 9 deletions.
4 changes: 4 additions & 0 deletions cards_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,10 @@ def pager
ENV['PAGER'] or 'less -R'
end

def ident_text prefix, text
prefix + text.split("\n").join("\n#{prefix}").chomp
end

@doc = {}
@doc_str = nil
def doc str
Expand Down
15 changes: 13 additions & 2 deletions commands/dir.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,23 @@
char_gets
end

doc "Начать редактировать .dairy файл"
doc <<EOF
Начать редактировать .dairy файл
В этом файле надо хранить журнал проектных решений -
что было принято и почему
EOF
dir_cmd :goto_dairy_file do |dir|
edit_file fjoin(dir, '.dairy').ex
end

doc "Начать редактировать .prj файл"
doc <<EOF
Начать редактировать .prj файл
Содержимое этого файла всегда показывается в просмотре каталога.
В этом файле надо держать цель каталога и заметки, что важно держать
перед глазами
EOF
dir_cmd :goto_prj_file do |dir|
edit_file fjoin(dir, '.prj').ex
end
Expand Down
14 changes: 7 additions & 7 deletions commands/global.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,22 @@
str = ob do
bind = rc('bind')
bind.each_key do |k|
print "\"#{k}\""
print "\"#{k.green}\""
if (v = bind[k]).class == String
puts " - #{bind[k]}"
puts " - #{bind[k].blue}"
if (v = @doc[bind[k].to_sym])
puts " #{v}"
puts ident_text(" ", v)
end
elsif v.class == Hash
puts " - #{v['name']}" if v['name']
puts " - #{v['name']}.blue" if v['name']
v.each_key do |kk|
if kk == 'name'
next
end
print " \"#{kk}\""
puts " - #{v[kk]}"
print " \"#{kk.green}\""
puts " - #{v[kk].blue}"
if (t = @doc[v[kk].to_sym])
puts " #{t}"
puts ident_text(" ", t)
end
end
end
Expand Down

0 comments on commit 4b8af2a

Please sign in to comment.