Skip to content

Commit

Permalink
Rename skip() macro method to skip_file() in docs (crystal-lang#5488)
Browse files Browse the repository at this point in the history
  • Loading branch information
straight-shoota authored and RX14 committed Jan 2, 2018
1 parent 4f56a57 commit d3fed8b
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/compiler/crystal/macros.cr
Original file line number Diff line number Diff line change
Expand Up @@ -100,19 +100,19 @@ module Crystal::Macros

# Skips the rest of the file from which it is executed.
# Typical usage is to skip files that have platform specific code,
# without having to surround the most relevant code in `{%...%}` macro blocks.
# without having to surround the most relevant code in `{% if flag?(...) %} ... {% end %}` macro blocks.
#
# Example:
#
# ```
# # sth_for_osx.cr
# {% skip unless flag?(:darwin) %}
# {% skip_file unless flag?(:darwin) %}
#
# # Class FooForMac will only be defined if we're compiling on OS X
# class FooForMac
# end
# ```
def skip : Nop
def skip_file : Nop
end

# This is the base class of all AST nodes. This methods are
Expand Down

0 comments on commit d3fed8b

Please sign in to comment.