[seam-issues] [JBoss JIRA] Created: (SEAMWICKET-28) Misc documentation issues

Jozef Hartinger (JIRA) jira-events at lists.jboss.org
Fri Mar 4 04:00:45 EST 2011


Misc documentation issues
-------------------------

                 Key: SEAMWICKET-28
                 URL: https://issues.jboss.org/browse/SEAMWICKET-28
             Project: Seam for Apache Wicket
          Issue Type: Bug
    Affects Versions: 3.0.0.CR1
            Reporter: Jozef Hartinger
            Assignee: Shane Bryzak
            Priority: Minor
             Fix For: 3.0.0.Final


http://docs.jboss.org/seam/3/3.0.0.CR1/reference/html/wicket-features.html#injection
* "as descibed in the CDI reference" - should be "as *described* in the CDI reference"
** besides, I am not sure if "CDI reference" means anything - it should probably be CDI reference documentation / CDI reference guide / CDI specification
* "in an JavaEE environment" - should be "in *a* JavaEE environment"
http://docs.jboss.org/seam/3/3.0.0.CR1/reference/html/wicket-features.html#conversationPropagation
* "Note that the above process indicates that after a conversation is marked long-running by a page, requests back to that page (whether ajax or not) will activate that conversation."
** IMHO a verb is missing i.e. "requests sent back to that page"
* do not use (a) (b) etc. Use proper docbook elements to create an unordered list instead.
* "(Note that the final case also provides a mechanism for switching conversations: if a cid is specified in PageParameters, it will be used by bookmarkable pages, rather than the current conversation.)" - should be a note - placed within "<note>"





--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira


More information about the seam-issues mailing list