ant-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bugzi...@apache.org
Subject DO NOT REPLY [Bug 53018] New: editorial errors in manual/Tasks/depend.html
Date Sun, 01 Apr 2012 00:23:42 GMT
https://issues.apache.org/bugzilla/show_bug.cgi?id=53018

             Bug #: 53018
           Summary: editorial errors in manual/Tasks/depend.html
           Product: Ant
           Version: 1.8.2
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: normal
          Priority: P2
         Component: Documentation
        AssignedTo: notifications@ant.apache.org
        ReportedBy: dsb@smart.net
    Classification: Unclassified


* "The depend task supports an attribute, "closure" which controls ...":  There
  should be a corresponding comma after "closure."

* "For example, say there are three classes, A, which depends on B, which 
  in-turn depend on C.":  That "depend" should be "depends" (and "in-turn" 
  should be "in turn").

* "You should not include jars in this classpath which you do not expect to 
  change...":  That seems to have a dangling modifier.  Probably re-order the
  wording to "You should not include in this classpath jars which you do not   
  expect to change..." (and that "which" should be "that").

* "There are some source dependencies which depend will not detect.":  That
  period should be a colon (because of the indented list that follows).

* "Non public classes cause two problems. Firstly depend cannot relate the 
  class file to a source file. In the future this may be addressed using the 
  source file attribute in the classfile. Secondly, neither depend nor the 
  compiler tasks can detect when a non public class is missing. Inner classes 
  are handled by the depend task.":  Both occurrences of "non public" should
  be "non-public" ("non" is not a word, only a prefix).

* "If you use multiple source directories you can pass this attribute a 
  path of source directories.":  That use of "path" should not be abbreviated
  like that.  (It's too ambiguous)

  (Recall that there are (file/directory) pathnames and search paths (e.g.,
  Java's classpath), both of which are (ambiguously) referred to as "paths".)


* For the two examples at the end, the subject of the sentence after the
  example is not clear.  Things would be clearer (and more grammatical) if
  the text said "This example:" (or at least "This:") before the example
  code. (Actually, this pattern applies all over the manual, but )

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

Mime
View raw message