Document sheet_for in README

[MicahBrown]

PR for #447

@tgturner

[coveralls]

Coverage increased (+0.4%) to 94.155% when pulling 984506d on MicahBrown:document-sheet-for into 6f703f0 on roo-rb:master.

[chopraanmol1]

@MicahBrown thank you for opening this PR. What about adding a method sheet! (with bang, same functionality as sheet), and add depreciation warning in sheet method which could be removed in some major release. Depreciation warning can also include short description of both sheet_for and sheet! as alternate suggestion

[MicahBrown]

The sounds like a great idea. I might even go one step further and rename "sheet" to "default_sheet!" or "set_default_sheet!"

…

On Thu, Sep 13, 2018 at 9:00 PM Anmol Chopra ***@***.***> wrote: @MicahBrown <https://github.com/MicahBrown> thank you for opening this PR. What about adding a method sheet! (with bang, same functionality as sheet), and add depreciation warning in sheet method which could be removed in some major release. Depreciation warning can also include short description of both sheet_for and sheet! as alternate suggestion — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#451 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AEDXRjl0_-q0kz2SEd3eMGO0BJtKWM4tks5uaxvDgaJpZM4WohZt> .

[chopraanmol1]

default_sheet! and set_default_sheet! will be confusing given than we have default_sheet and default_sheet=

The functionality of sheet and default_sheet= differs which will make it more confusing.

I'm open for better method name over sheet!, but default_sheet! & set_default_sheet! is not a good option.

[MicahBrown]

"set_default" ?

…

On Thu, Sep 13, 2018 at 10:40 PM Anmol Chopra ***@***.***> wrote: default_sheet! and set_default_sheet! will be confusing give than we have default_sheet and default_sheet= The functionality of sheet and default_sheet= differs which will make it more confusing. I'm open for better method name over sheet!, but default_sheet! & set_default_sheet! is not a good option. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#451 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AEDXRl-cvNSXB_PB2lADMt2yEsF1spDoks5uazMsgaJpZM4WohZt> .

[chopraanmol1]

set_default what?

Method name doesn't say it has anything to do with sheet.

And generally in ruby we do not prefer set_ as a prefix (something= is prefered over set_something).

[tgturner]

@MicahBrown I think @chopraanmol1 is getting at a couple of things here:

1. changing the name from sheet to sheet! implies two things, that it modifies the object it was called on, and will return the object it was called on. Both of those are true in this case so would be nice to communicate to users.

2. we already have a direct accessor for default_sheet. The implementation between that and sheet are bit nuanced, so probably best to just have both for now.

I would love to see you implement the sheet! change. Let me know if you feel comfortable with that.

[GeoffAbtion]

There is a bunch of discussion in this thread that is not specially relevant to this PR which would be a useful addition to the documentation.

Can we merge this PR and link to this discussion from the appropriate issue thread?

Edit: A possible reason to not merge this: #455 (comment)