[weld-issues] [JBoss JIRA] Commented: (WELD-18) Documentation issues

[Dan Allen (JIRA)]

    [ https://jira.jboss.org/jira/browse/WELD-18?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12492656#action_12492656 ] 

Dan Allen commented on WELD-18:
-------------------------------

1) The sentence style lists is Gavin's preferred style. Since he uses this approach in the spec, we use it in the ref guide too.

2) The Game source is going to be reviewed by Peter shortly.

3) JavaServer Faces is the correct name for JSF.

4) I'm clarifying the situation with remove methods.

> Documentation issues
> --------------------
>
>                 Key: WELD-18
>                 URL: https://jira.jboss.org/jira/browse/WELD-18
>             Project: Weld
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 1.0.0.PREVIEW1 
>            Reporter: Jozef Hartinger
>            Assignee: Dan Allen
>             Fix For: 1.0.0.GA
>
>
> Here are some documentation issues:
> 1.) Unordered lists:
> In many places in documentation, I can see list items containing commas and periods at the end of line as well as "and" at the last but one item. These should not be there. Some occurences: 1.2.1, , 1.3.1, 1.3.2, etc
> 2.) Outdated source code for Game.java in section 3.4
> 3.) Java ServerFaces instead of JavaServer Faces in 3.4.2
> 4.) Section 1.3.2 unclear
> Third paragraph talks about a "remove" method or "remove method annotated with @Destructor". However, the source code excerpt that follows this paragraph  shows "destroy" method annotated with "@Remove".

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira