[
https://issues.apache.org/jira/browse/JCS-124?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14494926#comment-14494926
]
Richard Eigenmann edited comment on JCS-124 at 4/14/15 9:30 PM:
----------------------------------------------------------------
Thanks!
Now, when we run it, there is rather a lot of verboseness from the JCS library.
Should we do something about that? I find it makes JCS look less mature than it
is.
was (Author: richardeigenmann):
Thanks!
Now, when we run it, there is rather a lot of verboseness from the JCS library.
Should we do something about that? I find makes JCS look less mature than it is.
> 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-beta-1
> Environment: Testing
> Reporter: Richard Eigenmann
> Assignee: Thomas Vandahl
> Fix For: jcs-2.0-beta-2
>
> Attachments: diff.txt, intro.xml
>
>
> 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.3.4#6332)
