Details
-
Bug
-
Status: Closed
-
Major
-
Resolution: Fixed
-
None
-
None
-
None
Description
[Draft reviewing is my 3rd job after java coding and open source coding, so figured I'd submit the grumbles about the groovy-user guide]
These are all pretty simple, so merging them into the one bug:
General: Could do with next-previous links at bottom of page.
Statements: equivlanent typo
Statements: '1.1. Important Note Note' looks like it is lacking markup
Statements:
looks like it didn't copy over from Wiki well
Statements: 'Expando' is a bit magic and not explained. A comment in the source example would be useful.
Strings: Could do with explanation as to whether all Strings are GStrings, or if they have to be specially created. An example needed if all Strings are not GStrings.
Collections: implemenation typo
Collections: increment/decrement are not Comparable methods. Where do they come from?
Collections: Needs example of subscripting on a Map/Regex
Logical branching: Provide link to Groovy class that needs extending to provide own Matcher for switch statements.
Looping: Lack of a Map example for a 'for' loop. It's needed as it either is, or could be expected to be, different to the others.
Classes: Need example of a class for first section.
Classes: Bad indentation on the UseFoo example.
Classes: The last example needs a better name than foo. It's the first time the reader has met the idea of pushing a value onto a list using a bit-shift operator, so a better name would save having to explain this.
Java differences: 'Use then' typo.
Java differences:
links failed to come over from Wiki
Regex: This page is not linked from the user-guide contents. Seems a better fit to the user guide than the 'Features' section.