You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by "Bruno P. Kinoshita (Created) (JIRA)" <ji...@apache.org> on 2011/10/25 18:46:32 UTC

[jira] [Created] (FUNCTOR-4) Add easily accessible, user-friendly examples

Add easily accessible, user-friendly examples
---------------------------------------------

                 Key: FUNCTOR-4
                 URL: https://issues.apache.org/jira/browse/FUNCTOR-4
             Project: Commons Functor
          Issue Type: Improvement
            Reporter: Bruno P. Kinoshita
            Priority: Minor


Perhaps we could add some pages with examples to the project site? 

As pointed by Emmanuel Bourg, at moment the examples point directly to classes in the SVN.  We could add some basic examples and also point to sample code in the SVN, something similar to what is done in DBUtils [1] and Commons-Pool [2].

I'm reading FP for Java Developers, there are some basic examples that could be implemented using Functor and put in the Examples page (I believe grand part is already implemented in the tests classes).

[1] http://commons.apache.org/dbutils/examples.html
[2] http://commons.apache.org/pool/examples.html

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Issue Comment Edited] (FUNCTOR-4) Add easily accessible, user-friendly examples

Posted by "Bruno P. Kinoshita (Issue Comment Edited) (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/FUNCTOR-4?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13144105#comment-13144105 ] 

Bruno P. Kinoshita edited comment on FUNCTOR-4 at 11/4/11 4:22 PM:
-------------------------------------------------------------------

Added a patch with some examples for review. 

Also uploaded the site to http://www.kinoshita.eti.br/public_files/site/examples.html, so you can see it in your browser too. 

- Added links to javadoc, just like DBTUtils does
- Added examples for Predicate, Function and Procedure, following the order that they appear in the main page
- Added an extra example that combines the three functors with generator and composite functors
- Removed the information on how to build
- Moved the practical part (and more advanced) to the bottom of the page, so the reader may already have some notion on the basics before reading it

Seems like the links to all the code katas are being redirected to http://pragdave.pragprog.com/. Not sure if they are available somewhere else or should be removed/updated.

I'm learning functional programming to use Functor in another open source project, so forgive me in case there are any mistakes. Feel free to modify the patch, criticize or propose changes. No hard feelings :-) 

Cheers, have a great WE.

Bruno P. Kinoshita
                
      was (Author: kinow):
    Added a patch with some examples for review. Thanks, Bruno P. Kinoshita
                  
> Add easily accessible, user-friendly examples
> ---------------------------------------------
>
>                 Key: FUNCTOR-4
>                 URL: https://issues.apache.org/jira/browse/FUNCTOR-4
>             Project: Commons Functor
>          Issue Type: Improvement
>            Reporter: Bruno P. Kinoshita
>            Priority: Minor
>         Attachments: FUNCTOR-4.patch
>
>
> Perhaps we could add some pages with examples to the project site? 
> As pointed by Emmanuel Bourg, at moment the examples point directly to classes in the SVN.  We could add some basic examples and also point to sample code in the SVN, something similar to what is done in DBUtils [1] and Commons-Pool [2].
> I'm reading FP for Java Developers, there are some basic examples that could be implemented using Functor and put in the Examples page (I believe grand part is already implemented in the tests classes).
> [1] http://commons.apache.org/dbutils/examples.html
> [2] http://commons.apache.org/pool/examples.html

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (FUNCTOR-4) Add easily accessible, user-friendly examples

Posted by "Bruno P. Kinoshita (Commented) (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/FUNCTOR-4?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13135262#comment-13135262 ] 

Bruno P. Kinoshita commented on FUNCTOR-4:
------------------------------------------

You're right indeed Matt. Thanks for the heads up.

Perhaps we could then create just basic examples covering the basics (Functor, Predicate, Procedure, operations on data structures) without using the examples of the book, what would be simpler.
                
> Add easily accessible, user-friendly examples
> ---------------------------------------------
>
>                 Key: FUNCTOR-4
>                 URL: https://issues.apache.org/jira/browse/FUNCTOR-4
>             Project: Commons Functor
>          Issue Type: Improvement
>            Reporter: Bruno P. Kinoshita
>            Priority: Minor
>
> Perhaps we could add some pages with examples to the project site? 
> As pointed by Emmanuel Bourg, at moment the examples point directly to classes in the SVN.  We could add some basic examples and also point to sample code in the SVN, something similar to what is done in DBUtils [1] and Commons-Pool [2].
> I'm reading FP for Java Developers, there are some basic examples that could be implemented using Functor and put in the Examples page (I believe grand part is already implemented in the tests classes).
> [1] http://commons.apache.org/dbutils/examples.html
> [2] http://commons.apache.org/pool/examples.html

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Resolved] (FUNCTOR-4) [PATCH] Add easily accessible, user-friendly examples

Posted by "Simone Tripodi (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/FUNCTOR-4?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Simone Tripodi resolved FUNCTOR-4.
----------------------------------

       Resolution: Fixed
    Fix Version/s: 1.0
         Assignee: Simone Tripodi

charming like a sunshine, patch applied, see r1344790

thanks once again Bruno!
                
> [PATCH] Add easily accessible, user-friendly examples
> -----------------------------------------------------
>
>                 Key: FUNCTOR-4
>                 URL: https://issues.apache.org/jira/browse/FUNCTOR-4
>             Project: Commons Functor
>          Issue Type: Improvement
>            Reporter: Bruno P. Kinoshita
>            Assignee: Simone Tripodi
>            Priority: Minor
>             Fix For: 1.0
>
>         Attachments: FUNCTOR-4.patch
>
>
> Perhaps we could add some pages with examples to the project site? 
> As pointed by Emmanuel Bourg, at moment the examples point directly to classes in the SVN.  We could add some basic examples and also point to sample code in the SVN, something similar to what is done in DBUtils [1] and Commons-Pool [2].
> I'm reading FP for Java Developers, there are some basic examples that could be implemented using Functor and put in the Examples page (I believe grand part is already implemented in the tests classes).
> [1] http://commons.apache.org/dbutils/examples.html
> [2] http://commons.apache.org/pool/examples.html

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Updated] (FUNCTOR-4) Add easily accessible, user-friendly examples

Posted by "Bruno P. Kinoshita (Updated) (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/FUNCTOR-4?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Bruno P. Kinoshita updated FUNCTOR-4:
-------------------------------------

    Attachment: FUNCTOR-4.patch

Added a patch with some examples for review. Thanks, Bruno P. Kinoshita
                
> Add easily accessible, user-friendly examples
> ---------------------------------------------
>
>                 Key: FUNCTOR-4
>                 URL: https://issues.apache.org/jira/browse/FUNCTOR-4
>             Project: Commons Functor
>          Issue Type: Improvement
>            Reporter: Bruno P. Kinoshita
>            Priority: Minor
>         Attachments: FUNCTOR-4.patch
>
>
> Perhaps we could add some pages with examples to the project site? 
> As pointed by Emmanuel Bourg, at moment the examples point directly to classes in the SVN.  We could add some basic examples and also point to sample code in the SVN, something similar to what is done in DBUtils [1] and Commons-Pool [2].
> I'm reading FP for Java Developers, there are some basic examples that could be implemented using Functor and put in the Examples page (I believe grand part is already implemented in the tests classes).
> [1] http://commons.apache.org/dbutils/examples.html
> [2] http://commons.apache.org/pool/examples.html

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Updated] (FUNCTOR-4) [PATCH] Add easily accessible, user-friendly examples

Posted by "Bruno P. Kinoshita (Updated) (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/FUNCTOR-4?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Bruno P. Kinoshita updated FUNCTOR-4:
-------------------------------------

    Summary: [PATCH] Add easily accessible, user-friendly examples  (was: Add easily accessible, user-friendly examples)
    
> [PATCH] Add easily accessible, user-friendly examples
> -----------------------------------------------------
>
>                 Key: FUNCTOR-4
>                 URL: https://issues.apache.org/jira/browse/FUNCTOR-4
>             Project: Commons Functor
>          Issue Type: Improvement
>            Reporter: Bruno P. Kinoshita
>            Priority: Minor
>         Attachments: FUNCTOR-4.patch
>
>
> Perhaps we could add some pages with examples to the project site? 
> As pointed by Emmanuel Bourg, at moment the examples point directly to classes in the SVN.  We could add some basic examples and also point to sample code in the SVN, something similar to what is done in DBUtils [1] and Commons-Pool [2].
> I'm reading FP for Java Developers, there are some basic examples that could be implemented using Functor and put in the Examples page (I believe grand part is already implemented in the tests classes).
> [1] http://commons.apache.org/dbutils/examples.html
> [2] http://commons.apache.org/pool/examples.html

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (FUNCTOR-4) Add easily accessible, user-friendly examples

Posted by "Matt Benson (Commented) (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/FUNCTOR-4?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13135244#comment-13135244 ] 

Matt Benson commented on FUNCTOR-4:
-----------------------------------

This is probably possible, but based on the text in preface section 3 we should seek permission IMO, even if the code is not directly copied.  Better safe than sorry.
                
> Add easily accessible, user-friendly examples
> ---------------------------------------------
>
>                 Key: FUNCTOR-4
>                 URL: https://issues.apache.org/jira/browse/FUNCTOR-4
>             Project: Commons Functor
>          Issue Type: Improvement
>            Reporter: Bruno P. Kinoshita
>            Priority: Minor
>
> Perhaps we could add some pages with examples to the project site? 
> As pointed by Emmanuel Bourg, at moment the examples point directly to classes in the SVN.  We could add some basic examples and also point to sample code in the SVN, something similar to what is done in DBUtils [1] and Commons-Pool [2].
> I'm reading FP for Java Developers, there are some basic examples that could be implemented using Functor and put in the Examples page (I believe grand part is already implemented in the tests classes).
> [1] http://commons.apache.org/dbutils/examples.html
> [2] http://commons.apache.org/pool/examples.html

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira