Added SanitizeHelper to rails guide docs [ci skip] #11617
Conversation
| @@ -1520,6 +1520,59 @@ number_with_precision(111.2345) # => 111.235 | |||
| number_with_precision(111.2345, 2) # => 111.23 | |||
| ``` | |||
|
|
|||
| This is for a single use. | |||
|
|
|||
There was a problem hiding this comment.
I don't really understand this line. Could you explain what you mean please? :-)
|
Hello, Thanks for your contribution! ❤️ I've added some comments. Could you just wrap these helpers with a title (here SanitizeHelper) please? |
|
Super pwned! Thanks for the feedback I'll get right on it. On 26 July 2013 at 17:39:26, Robin Dupret (notifications@github.com) wrote: Hello, Thanks for your contribution! I've added some comments. Could you just wrap these helpers with a title (here SanitizeHelper) please? — |
|
Oops. My bad, too many files open. |
|
Could you just squash your commits into a single one please? $ git rebase -i HEAD~3
# Replace pick with squash except for the first commit
$ git push origin +doc_sanitize |
|
You learn something new every day… -- On 26 July 2013 at 17:56:16, Robin Dupret (notifications@github.com) wrote: Could you just squash your commits into a single one please? $ git rebase -i HEAD~3 Replace pick with squash except for the first commit$ git push origin +doc_sanitize |
Yeah, especially with Git! Didn't see any error with the snippet I've posted? Seems like this hasn't applied correctly. |
Added SanitizeHelper to rails guide docs [ci skip] Added SanitizeHelper to rails guide docs update [ci skip]
|
I think I won. Curse my poor spelling. |
|
Awesome, thanks you! :-) LGTM /cc @fxn |
|
No problem, thanks for being so helpful!
|
|
I feel like this kind of documentation is too similar to the Rails API documentation I don't see a good reason to duplicate the documentation on the method level. I know that there are already modules documented that way in this guide, I just don't think it's particularly useful. @steveklabnik @fxn what do you guys think? |
|
Yeah it's a middle ground. We have some guides that are like this; the validations guide, for example. I am also a vague 👎 , but since we have other things like this, maybe this should be in too. @fxn? |
|
Yeah, there is no good solution I am afraid. Some guides are more detailed, the most extreme one is the Active Support guide that not only documents at the API level, but it is more informative than the API itself for some methods (motivation is to provide a central point to read about extensions to core classes). This guide has also a section where helpers are listed... gray area. In general I believe we should avoid duplication. Find a balanced point and at most cross-link ("read the API documentation for further details", something like that). Which reminds me that I need to figure out a way to cross-link. The patch is fine for me though, no reason strong enough not to apply. |
Added SanitizeHelper to rails guide docs [ci skip]
|
@fxn @steveklabnik @senny : Maybe we could just put a list of links pointing to the different methods/helpers and try to enhance as possible the API to avoid duplication? If you want me to help you at this level, I would be glad! |
|
@robin850 I think we could leave these as they are by now. |
No description provided.