module DevTraining::FormattingHelpers

A few helpers for formatting issue text. Available as module functions for convenience, but also included in DevTraining::Issue

Public Instance Methods

format_body (desc, subtasks = nil)

Source

# File lib/dev_training/formatting_helpers.rb, line 13
def format_body(desc, subtasks = nil)
  return desc if subtasks.nil?

  [desc, format_checklist(subtasks)].compact.join "\n\n"
end

Returns desc, and optionally if subtasks is a non-empty Array, the results of format_checklist tacked on after a blank line.

format_checklist (checklist)

Source

# File lib/dev_training/formatting_helpers.rb, line 21
def format_checklist(checklist)
  checklist.map { |item| "* [ ] #{item}" }.join("\n")
end

Makes a GFM “tasklisk” with one item per item in checklist