commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Richard Eigenmann (JIRA)" <j...@apache.org>
Subject [jira] [Created] (JCS-124) Make the code in Step 5 on the JCS overview page a full working class that can compile
Date Sun, 04 May 2014 11:38:14 GMT
Richard Eigenmann created JCS-124:
-------------------------------------

             Summary: Make the code in Step 5 on the JCS overview page a full working class
that can compile
                 Key: JCS-124
                 URL: https://issues.apache.org/jira/browse/JCS-124
             Project: Commons JCS
          Issue Type: Improvement
          Components: Documentation
    Affects Versions: jcs-2.0.0
         Environment: Testing
            Reporter: Richard Eigenmann
             Fix For: jcs-2.0.0


Step 5: http://commons.apache.org/proper/commons-jcs/getting_started/intro.html

Please make this a fully compilable class that can be cut and pasted for a quick success experience
for the newby.

Defaults and examples are extremely powerful and many people never venture further than the
defaults and samples they discovered so it is extremely important to show sensible default
values and good code.

In this vein, drop the words "might" and "could" in the comments. It's either a good way to
do it or you should not be showing it for it will be copied.

Please also correct the setCache(c); instruction which doesn't make sense. The example doesn't
indicate that it is extending another class where setCache(c) might be defined and isn't defining
the method. Is this instruction needed?




--
This message was sent by Atlassian JIRA
(v6.2#6252)

Mime
View raw message