[dna-issues] [JBoss JIRA] Created: (DNA-558) DNA documentation problem

Tom Ruff (JIRA) jira-events at lists.jboss.org
Tue Nov 24 17:10:29 EST 2009


DNA documentation problem
-------------------------

                 Key: DNA-558
                 URL: https://jira.jboss.org/jira/browse/DNA-558
             Project: DNA
          Issue Type: Bug
          Components: Documentation
    Affects Versions: 0.6
            Reporter: Tom Ruff


This applies to the DNA Reference Guide at the following link:
http://docs.jboss.org/jbossdna/latest/manuals/reference/html/sequencing_framework.html#stream-sequencers

In chapter 7.2, Stream Sequencers, the following sentence left out a key word ("context").  
So this:
"The provides additional details about the information that is being sequenced, including the location and properties of the node being sequenced, the MIME type of the node being sequenced, and a Problems object where the sequencer can record problems that aren't severe enough to warrant throwing an exception. "

Should be this:
"The context provides additional details about the information that is being sequenced, including the location and properties of the node being sequenced, the MIME type of the node being sequenced, and a Problems object where the sequencer can record problems that aren't severe enough to warrant throwing an exception. "

Also, immediately above that in the code block the type for the context parameter isn't provided - with javadoc hyperlink - as it is for the other two parameters.  Yes, I know this should probably be a separate issue.

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

        


More information about the dna-issues mailing list