[ 
https://issues.apache.org/jira/browse/MAHOUT-831?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13123497#comment-13123497
 ] 

Robert Muir commented on MAHOUT-831:
------------------------------------

FYI One thing we did in lucene was to make these show up in the javadocs (not 
sure how important this is for mahout).

This way when you read the documentation, you see a big bold warning if its 
experimental...

example: 
http://lucene.apache.org/java/3_4_0/api/core/org/apache/lucene/index/IndexCommit.html

{noformat}
        <tag name="lucene.experimental" 
        description="WARNING: This API is experimental and might change in 
incompatible ways in the next release."/>
{noformat}

A difference is that ours are not actually real annotations, but just javadocs 
tags and we added this to the javadocs processing.
                
> @Experimental annotation to indicate which implementations are not intended 
> for production use
> ----------------------------------------------------------------------------------------------
>
>                 Key: MAHOUT-831
>                 URL: https://issues.apache.org/jira/browse/MAHOUT-831
>             Project: Mahout
>          Issue Type: Improvement
>    Affects Versions: 0.6
>            Reporter: Sebastian Schelter
>            Assignee: Sebastian Schelter
>         Attachments: MAHOUT-831-2.patch, MAHOUT-831.patch
>
>


--
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

        

Reply via email to