Anshorei
/
squib
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: cleanup of parameters page 

[skip ci]
dev
Andy Meneely 2016-11-05 00:23:17 -04:00
parent d0e1e2613a
commit 3d46888b28
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/parameters.rst
View File

@ -3,11 +3,15 @@ Parameters are Optional
Squib is all about sane defaults and shorthand specification. Arguments to DSL methods are almost always using hashes, which look a lot like `Ruby 2.0's named parameters <http://www.ruby-doc.org/core-2.0.0/doc/syntax/calling_methods_rdoc.html#label-Keyword+Arguments>`_. This means you can specify your parameters in any order you please. All parameters are optional. Squib is all about sane defaults and shorthand specification. Arguments to DSL methods are almost always using hashes, which look a lot like `Ruby 2.0's named parameters <http://www.ruby-doc.org/core-2.0.0/doc/syntax/calling_methods_rdoc.html#label-Keyword+Arguments>`_. This means you can specify your parameters in any order you please. All parameters are optional.
For example `x` and `y` default to 0 (i.e. the upper-left corner of the card). Any parameter that is specified in the command overrides any Squib defaults, `config.yml` settings, or layout rules. For example ``x`` and ``y`` default to ``0`` (i.e. the upper-left corner of the card). Any parameter that is specified in the command overrides any Squib defaults or layout rules.
.. highlight:: none You must use *named parameters* rather than *positional parameters*. For example::
Note: you MUST use named parameters rather than positional parameters. For example: ``save :png`` will lead to an error like this:: save(:png) # wrong
will lead to an error like this:
.. code-block:: none
C:/Ruby200/lib/ruby/gems/2.0.0/gems/squib-0.0.3/lib/squib/api/save.rb:12:in `save': wrong number of arguments (2 for 0..1) (ArgumentError) C:/Ruby200/lib/ruby/gems/2.0.0/gems/squib-0.0.3/lib/squib/api/save.rb:12:in `save': wrong number of arguments (2 for 0..1) (ArgumentError)
from deck.rb:22:in `block in <main>' from deck.rb:22:in `block in <main>'
@ -16,11 +20,15 @@ Note: you MUST use named parameters rather than positional parameters. For examp
from deck.rb:18:in `new' from deck.rb:18:in `new'
from deck.rb:18:in `<main>' from deck.rb:18:in `<main>'
Instead, you must name the parameters: `save format: :png` Instead, you must name the parameters::
save(format: :png) # the right way
.. warning:: .. warning::
If you provide an option to a DSL method that the DSL method does not recognize, Squib ignores the extraenous option without warning. For example, these two calls have identical behavior:: If you provide an option to a DSL method that the DSL method does not recognize, Squib ignores the extraenous option without warning. For example, these two calls have identical behavior::
save_png prefix: 'front_' save_png prefix: 'front_'
save_png prefix: 'front_', narf: true save_png prefix: 'front_', narf: true # narf has no effect
This can be troublesome when you accidentally misspell an option and don't realize it.