axis-java-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bugzi...@apache.org
Subject DO NOT REPLY [Bug 21450] New: - editorial errors in Axis User's Guide
Date Wed, 09 Jul 2003 21:21:12 GMT
DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG 
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://nagoya.apache.org/bugzilla/show_bug.cgi?id=21450>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND 
INSERTED IN THE BUG DATABASE.

http://nagoya.apache.org/bugzilla/show_bug.cgi?id=21450

editorial errors in Axis User's Guide

           Summary: editorial errors in Axis User's Guide
           Product: Axis
           Version: 1.1
          Platform: Other
               URL: http://cvs.apache.org/viewcvs.cgi/~checkout~/xml-
                    axis/java/docs/user-guide.html
        OS/Version: Other
            Status: NEW
          Severity: Normal
          Priority: Other
         Component: Documentation
        AssignedTo: axis-dev@ws.apache.org
        ReportedBy: dsb@smart.net


There are a number of editorial errors in the Axis User's Guide:


- "If your exception meet this specification"

  (should be "If your exception meets this specification")


- "...of the exception , regardless of platform..."

  (should be "...exception, regardless...")


- "(i.e arguments of..."

  (should be "(i.e., arguments of...")

- "i.e. make available to"

  (should be "i.e., make available to")

- "(i.e. my.java.thingy)"

  (should be "(i.e., my.java.thingy)")


- "This is neither part of the SOAP specification, or the JAX-RPC 
  specification."

  (should be "...neither..., nor ....")

-
    Remote References

    This is neither ... 

  (should be:

    Remote References

    Remote references are neither ... 

  (The text should stand on its own, independent of any headers, as does
  most of the User's guide text.  For example, the previous section begins:

    Arbitrary Objects without Pre-Registration

    You cannot send arbitrary Java objects ...

  ))


- "...will result in a fault (if you want to try this for yourself, you can use 
   the bad-deploy.wsdd file in the example5 directory)."

  (should be "...will result in a fault.  (If...directory.)")












- "If a method is marked as throwing an Exception, that is not an instance 
  or a subclass of java.rmi.RemoteException, then ..."

  ("...Exception, that..." should be "...an Exception that...")

- "Interoperability, interop is an ongoing challenge..."

  (should be "Interoperability, interop, is an ongoing challenge...")

- "Some of the Collection classes, such as Hashtable do have serializers"

  (should be "...the...classes, such as Hashtable, do...")



- "At least, until a revision of JAX-RPC adds this."

  (sentence fragment--join with previous sentence somehow)



- "(see the SOAP spec for more on multi-ref serialization)"

  (should be "(See the SOAP spec for more on multi-ref serialization.)")

- "(note that you may need to replace the "-p8080" with whatever port your 
  J2EE server is running on)"

  (should be "(Note that you may need to replace the "-p8080" with whatever 
  port your J2EE server is running on.)"


- "(in this case there's just "arg0")"

   (should be "(In this case there's just "arg0".)"

- "Note: to actually watch ..."

   (Should be "Note: To actually watch ..."

- "...services are similar in that ..., it's just plain ..."

  (should be "...services are similar in that ...; it's just plain ...")


- "rpc-encoded"

   (should be "RPC-encoded")

- "One, serializer, is .... Two, deserializer, is ..."

  ("Two" should be something like "Another" or "The second".)

- "Finally, the encodingStyle, which is SOAP encoding."

  (sentence fragment)


- "the AXIS WSDL -> Java tool"

  (would be much clearer (and standard English) as "the AXIS WSDL-to-Java 
  tool")

- "wsdel:binding"

  (should be "wsdl:binding")

- "Since document/literal changes..." (twice)

  (is unclear and ambiguous, should be something like 'Since using "document"
   vs. "literal" changes...')






A non-editorial problem:

- "A holder class is simply a class that contains an instance of its type."  

  That should probably say something like "an instance of its associated
  type."  Since a class is a type, referring to "its type" is ambiguous.

Mime
View raw message