Skip to content

README.md

Latest commit

 

History

History
43 lines (37 loc) · 1.74 KB

README.md

File metadata and controls

43 lines (37 loc) · 1.74 KB

Ruby

The ruby style guide consists of the community accepted and standardized rules as outlined in these guides:

Addendums to these standards are to be outlined and described below, and supported with additional rubocop configurations as defined in this gem.

RuboCop

Every project should start with the .rubocop.yml present here. It should enforce the styles defined here. If a change or addition comes up in the course of that project that is not project-specific, it should be made in the style guide.

Addendums

Documentation

All documentation should be generated using the minimal comments required. Following the YARD specification. Documentation check is disabled via rubocop.

# Converts the object into textual markup given a specific format.
#
# @todo Write the function
# @param format [Symbol] the format type, `:text` or `:html`
# @return [String] the object converted into the expected format.
def to_format(format = :html)
  # format the object
end

Percent Literal Delimiters

Percent Literal Delimiters have been adjusted to reflect encoded meaning via the wrapping symbols.

  • () Signifies white space is captured and used
  • [] Signifies white space is discarded and an array is returned
%(echo one)   => "echo one"
%q(echo one)  => "echo one"
%Q(echo one)  => "echo one"
%i[echo one]  => [:echo, :one]
%I[echo one]  => [:echo, :one]
%r(echo one)  => /echo one/
%s(echo one)  => :"echo one"
%w[echo one]  => ["echo", "one"]
%W[echo one]  => ["echo", "one"]
%x(echo one)  => "one\n"