1. #1
    Sencha - Ext JS Dev Team Animal's Avatar
    Join Date
    Mar 2007
    Location
    Notts/Redwood City
    Posts
    30,546
    Vote Rating
    64
    Animal is a jewel in the rough Animal is a jewel in the rough Animal is a jewel in the rough

      0  

    Default Example code in API docs. Your chance to contribute.

    Example code in API docs. Your chance to contribute.


    People are always asking for more examples in the API docs.

    So, here is your chance to contribute.

    If there is an ambiguous, or tricky method, config, event or property that you have discovered and used, then post a code snippet of up to 20 lines which gives an example of its usage.

    Please keep the snippets to the point. Please use comments in the code.

    Format it using Ext standard indentation and {},[] wrapping style. Use spaces for indentation. 4 spaces per indent level.

    I will monitor this thread and try to put the contributed code (Or edited versions) into the API docs in the correct place.

    Be sure to include the full specification of where, which class + config/property/method/event the code is to illustrate.

    Edit:
    Unfortunately, all code sample to be integrated into the documentation must include a public domain license grant at the top to satisfy questions like this.

  2. #2
    Sencha Premium Member
    Join Date
    Jun 2008
    Posts
    324
    Vote Rating
    10
    Scorpie will become famous soon enough

      0  

    Default


    Awesome! I will look into my codebase tonight when I get back from work!

  3. #3
    Banned
    Join Date
    Mar 2007
    Posts
    57
    Vote Rating
    0
    buzz is on a distinguished road

      0  

    Default


    Under what license is the contributed code snippets going to released?

  4. #4
    Sencha - Ext JS Dev Team Animal's Avatar
    Join Date
    Mar 2007
    Location
    Notts/Redwood City
    Posts
    30,546
    Vote Rating
    64
    Animal is a jewel in the rough Animal is a jewel in the rough Animal is a jewel in the rough

      0  

    Default


    It's just example code!

  5. #5
    Sencha - Community Support Team mystix's Avatar
    Join Date
    Mar 2007
    Location
    Singapore
    Posts
    6,236
    Vote Rating
    5
    mystix will become famous soon enough

      0  

    Default


    Quote Originally Posted by buzz View Post
    Under what license is the contributed code snippets going to released?
    tell me you're not serious...

  6. #6
    Banned
    Join Date
    Mar 2007
    Posts
    57
    Vote Rating
    0
    buzz is on a distinguished road

      0  

    Default


    mystix, are you suggesting that contributions of code snippets to enhance the docs are not really contributions to Ext? Is it not going to be bundled with Ext? Just trying to follow your rationale on why you think this is not a serious matter.

  7. #7
    Sencha - Community Support Team mystix's Avatar
    Join Date
    Mar 2007
    Location
    Singapore
    Posts
    6,236
    Vote Rating
    5
    mystix will become famous soon enough

      0  

    Default


    well, i really don't+can't see the difference between posting a complete example on the forums and cloning that example in an API.

    it is, after all, an example. you're not posting propriety code online to be viewed by the community.
    you're volunteering an example.

  8. #8
    Sencha - Ext JS Dev Team Animal's Avatar
    Join Date
    Mar 2007
    Location
    Notts/Redwood City
    Posts
    30,546
    Vote Rating
    64
    Animal is a jewel in the rough Animal is a jewel in the rough Animal is a jewel in the rough

      0  

    Default


    If you want to keep your code secret, don't post example snippets on this thread.

    If you want to contribute to the excellence of the Ext API docs, post example snippets on this thread.

    Seems simple to me.

  9. #9
    Banned
    Join Date
    Mar 2007
    Posts
    57
    Vote Rating
    0
    buzz is on a distinguished road

      0  

    Default


    For e.g., I write a new widget or plugin and don't want to keep my contributions secret but rather post it on the forum for the community. This does not mean that Ext can take it and include it in their product and sell under commercial license without a signed CLA from me. The same logic applies to this thread. You cant simply bypass the legal process by stating "if you want to contribute to the excellence of the Ext API docs, post example snippets on this thread."

  10. #10
    Ext User dantheman's Avatar
    Join Date
    Mar 2007
    Posts
    259
    Vote Rating
    1
    dantheman is on a distinguished road

      0  

    Default


    Quote Originally Posted by buzz View Post
    For e.g., I write a new widget or plugin and don't want to keep my contributions secret but rather post it on the forum for the community. This does not mean that Ext can take it and include it in their product and sell under commercial license without a signed CLA from me. The same logic applies to this thread. You cant simply bypass the legal process by stating "if you want to contribute to the excellence of the Ext API docs, post example snippets on this thread."
    With respect, get over yourself.

    --dan