| Issue 570: | List of arguments supplied to filters and callbacks and working examples of usage. | |
| 1 person starred this issue and may be notified of changes. | Back to list |
|
I've been using the nyromodal version2 on a project that loads forms via ajax and then posts the results back to the same modal. This works well... good work. The problem is that in you documentation you list the filers and callbacks, but you don't supply a list of arguments that each accepts. This makes the documentation very limited and not as helpful as it could be. For example, you mention that filters can be used to retrieve a value from an ajax call and then pass with back to the parent page. However from your documentation it isn't at all clear as to how this would be achieved. Do you have any examples that show specific examples of how each filter/callback can be used? If not this would make any developers life much simpler and reduce the need to post issues here. That said you're done a great job so far. Regards JP Gorman
May 27, 2011
#1
m4s...@gmail.com
Jul 17, 2011
I second this issea
Jul 17, 2011
"All function or callbacks receive the same nyroModal object as a unique parameter."
Sep 15, 2011
People are raising the issue of lack of documentation and this is still not attended. There is no example code, not even one to show how to use the callbacks. The worst Teacher is one who don't know anything, but one who knows a lot but don't know how to explain and share his knowledge is same. This holds true for a software without proper documentation and this issue has been raised since 2008 and I think its high time now. The list of available options compelled me to use it but without documentation/example I am unable to use it so thinking of going against my decision. :(
Nov 18, 2011
I don't mean to be rude, or to think that the devs owe me anything, but I have to agree with these comments. I'm just getting into using NyroModal, and it's nearly impossible to understand the documentation. As a rule of thumb, if you have a feature, you need a code example. Right now there are 21 code examples in the documentation, and 13 of them have no other code except the parameter-less call to nyroModal(). 13 out of 21 of the examples provide no more information than the name of the plugin! This leaves 8 examples to try to explain all the features of the library. That can hardly be considered documentation. I understand that you are doing this for free in your spare time, and believe me, we all appreciate it. I'm sure more than half of those who complain about the documentation would gladly pitch in to help improve it, but nobody can figure out your library. As for your response in this thread where you simply quote the documentation, that is of no use to anybody. If the documentation didn't make sense on the documentation page, why would it make more sense in a forum? Would it have taken you that much more time to post the much desired code example in this thread, instead of the very documentation we are all complaining about? A simple snippet of code using a custom filter and a predefined filter would do a much better job of stopping the flow of negative comments that fill up your bug tracker. The way I see it, is that your project has more value to you if people use it. If everyone abandons it for something else, you have no chance of ever getting anything out of your hard work. Code examples are such a trivial thing to throw away your efforts over. Everyone would appreciate it if you provided them. Thank you, again, for all your work. I mean that sincerely.
Feb 8, 2012
I'd have to agree. Examples would make it so much easier to use. I'm down to contribute and write some examples once I figure out how to use nyroModal! thanks very much Cederic! nyroModal is still excellent, even though it could use a few more examples. |
||||||