Updated documentation #9

Merged
merged 2 commits into from May 26, 2012

Conversation

Projects
None yet
2 participants
Contributor

akzhan commented May 26, 2012

YARD and Markdown.

Owner

phallstrom commented May 26, 2012

Akzhan - Looks good. Couple of questions (more curious than anything else).

Why did you change def options=(opts = {}) to def options=(value = {}) ? Does YARD like 'value' over 'opts'?

And in two other methods you removed the default value of {} from the argument. Was there a reason for that?

Contributor

akzhan commented May 26, 2012

@phallstrom Yard likes default values.

There is another issue: You can't call these methods without options/params simply because some of its options/params are required - as seen by code (and now by documentation).

Contributor

akzhan commented May 26, 2012

Oops, You ask for something totally different :)

Yes, !@attribute declaration looks only for value parameter for setters. It's Yard restriction for now.

Contributor

akzhan commented May 26, 2012

It's can be simply overriden, but there is another problem.

options= isn't setter. It should be removed due to its inadequate behaviour.

@phallstrom phallstrom added a commit that referenced this pull request May 26, 2012

@phallstrom phallstrom Merge pull request #9 from akzhan/master
Updated documentation and minor tweaks to argument defaults and error exceptions.
20369d5

@phallstrom phallstrom merged commit 20369d5 into phallstrom:master May 26, 2012

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment