-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix README: add parse:true documentation #386
Conversation
Can you rebase against master and force push? |
@bf4, sure. Done. |
Maybe add a note that this depends on the |
@bf4, sure thing! Also I want to change all of the comment style in that block from inline comment to separated lines as this line on working and the last one are too long for readability. Is that okay? |
Sure |
@bf4, I tried to add the dependency words but found there are several places with similar case. Doing such would looks redundant so I ended adding a general note above "#Usage". rebased against the latest master and force pushed. |
@user.tag_list.remove("awesome", "slick") | ||
|
||
# "remove" works with string too, needing "parse: true" option. | ||
@user.tag_list.remove("awesome, slick", parse: true) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe?
alternatively, rather than passing in an array of tag arguments, you can pass in a string with a delimited list of tags to be parsed, with 'parse: true'
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or maybe there should just be a general section on the options hash most of the tagging methods take, separate from the general examples?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice idea. I think the alternative section is cleaner, just like the line "To preserve the order in which tags are created use acts_as_ordered_taggable" and its later section. I'll do that.
Hi @bf4, sorry for my late. I added quite a lot of changes on "Usage". Please take a look at first, I'll rebase it if everythings okay. Happy new year! |
Pretty good! I might want to re-read for grammar, but content looks good. |
[Doc] README: add parse:true documentation
Thanks! |
[Doc] README: add parse:true documentation
I found error when I followed README to add tags as
The result is one tag named "awesome, slicker" which is incorrect. I browsed source and found the right usage should be
The result is correct, two tags "awesome" and "slicker"
This pull request fixed the missing part in README.