groovy
  1. groovy
  2. GROOVY-2524

Javadoc typos for DefaultGroovyMethods

    Details

    • Type: Improvement Improvement
    • Status: Closed Closed
    • Priority: Trivial Trivial
    • Resolution: Fixed
    • Affects Version/s: 1.5.1
    • Fix Version/s: 1.6-rc-2
    • Component/s: groovy-jdk
    • Labels:
      None
    • Patch Submitted:
      Yes
    • Number of attachments :
      1

      Description

      Looking at the javadoc for the Groovy enhanced java.lang.Object there are some typos.

      From the dist docs 1.5.1 open the docs (/docs/html/groovy-jdk/index.html) and click on java.lang.Object.
      It list all the new methods we have (they are fab BTW)

      However there are a few typos and some JDK1.5 printf methods that are not in the summary.
      I have attached a patch for it. It was from the SVN from the trunk.

        Activity

        Hide
        Paul King added a comment -

        Added thanks. I didn't apply the two 'i.e. -> ie' changes. It is probably an improvement but in some parts of the world perhaps the traditional 'i.e.' is still preferred. There were 52 usages of 'i.e.' in the codebase (in comments) and one usage of 'ie' - now changed to 'i.e.' for consistency. So I would prefer to change them all at once if we are to change. For future note, there were 84 usages of 'e.g.' and none of 'eg'.

        Show
        Paul King added a comment - Added thanks. I didn't apply the two 'i.e. -> ie' changes. It is probably an improvement but in some parts of the world perhaps the traditional 'i.e.' is still preferred. There were 52 usages of 'i.e.' in the codebase (in comments) and one usage of 'ie' - now changed to 'i.e.' for consistency. So I would prefer to change them all at once if we are to change. For future note, there were 84 usages of 'e.g.' and none of 'eg'.
        Hide
        Claus Ibsen added a comment -

        Paul the i.e. gives a problem in the javadoc summary where it would cut the sentence short.
        We should use encoded for dots (cant remember the syntax) when doing i.e. or e.g.

        People forget this often, and it would be easier to just use without the dots (eg or ie)

        Show
        Claus Ibsen added a comment - Paul the i.e. gives a problem in the javadoc summary where it would cut the sentence short. We should use encoded for dots (cant remember the syntax) when doing i.e. or e.g. People forget this often, and it would be easier to just use without the dots (eg or ie)
        Hide
        Paul King added a comment -

        OK, the lightbulb finally turns on. I'll reopen until we fix this.

        Show
        Paul King added a comment - OK, the lightbulb finally turns on. I'll reopen until we fix this.
        Hide
        Paul King added a comment - - edited

        OK, now all instances of 'e.g.' and 'i.e.' are immediately followed by ' ' if used as the first sentence of javadoc. We can always do the 'eg/ie' swap later if this issue crops up again.

        Show
        Paul King added a comment - - edited OK, now all instances of 'e.g.' and 'i.e.' are immediately followed by ' ' if used as the first sentence of javadoc. We can always do the 'eg/ie' swap later if this issue crops up again.
        Hide
        Paul King added a comment -

        close off release 1.5.4

        Show
        Paul King added a comment - close off release 1.5.4

          People

          • Assignee:
            Paul King
            Reporter:
            Claus Ibsen
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: