11:04 a.m.
Miscellaneous typos and a handful of minor content issues
---------------------------------------------------------
Key: HHH-5261
URL: http://opensource.atlassian.com/projects/hibernate/browse/HHH-5261
Project: Hibernate Core
Issue Type: Bug
Components: documentation
Affects Versions: 3.5.2
Reporter: David M. Karr
Priority: Minor
This is a collection of typos and minor content issues found in the current Hibernate doc.
Technically, this represents multiple issues, but I'm not going to file one ticket
for every typo I found.
Section 1.1.4, p. 7, first "Note": Change "... this do that ..." to
"... this so that ...".
Section 1.2.4, p. 19, last paragraph. This paragraph has the first mention of "eager
fetch" in the manual, but without any explanation. In a tutorial, it's confusing
to mention technical terms without any background, and even worse when a technical term
doesn't even sound like a technical term.
Section 1.3.1, p. 20, change "... need create ..." to "... need to create
...".
Section 1.3.1, p. 21, first code sample. Using
"ServletException.class.isInstance(ex)" here seems odd. Why don't you use
the more common "ex instanceof ServletException"? The dynamic form is only
useful when the class is in a variable.
Section 1.3.1, p. 21, paragraph beginning "The pattern applied here ...". The
last sentence in this paragraph seems strange here. It refers to not using
"auto-commit", which is at least related to the subject of the paragraph, being
"session-per-request", but it seems like it was placed in this paragraph
accidentally.
Section 4.1.1, p. 52. This paragraph repeats a common misstatement I see in much of the
Java literature. The statement "All persistent classes must have a default
constructor" is incorrect. It should be "All persistent classes must have a
no-arguments constructor". The "default constructor" is the constructor
that the compiler creates in a class if no constructor is defined. The default
constructor is a no-arguments constructor, but the point is that persistent classes need a
no-arguments constructor, not a "default constructor".
Section 5.1.3, p. 65, definition of "batch-size". This explanation is confusing.
It says "... for fetching instances of this class by identifier." Fetching
instances of a class by an identifier value will only ever get one (or zero) rows.
Section 5.1.3, p. 65, definition of "rowid". Is this explanation correct? It
says "... once this option has been set to rowid.". You enable the
"rowid" property by setting it to "rowid"? If that's true, it
would be helpful to emphasize that. Most people would read that and be confused.
Section 5.1.4.5, p. 71. Change "The generator is used ..." to "This
generator is used ...".
Section 5.1.5, p. 71, paragraph beginning "The first of these new ...". Change
"portability generator" to, perhaps, "identity generator".
"portability generator", what a concept. :)
Section 5.1.13, p. 82, "constrained" definition. Change "... table and
references ..." to "... table references ...".
Section 11.1, p. 164, change "... already in the in the session ..." to
"... already in the session ...".
Section 11.1.1, p. 164. Change "... class can created ..." to "... class
can be created ...".
Chapter 12, p. 173, second paragraph. The paragraph ends with "... Hibernate provides
repeatable reads for lookup by identifier and entity queries and not reporting queries
that return scalar values." The "not reporting" part doesn't seem to
make sense. I can't tell what this was supposed to say.
Section 12.4, p. 185, change "... it never lock objects ..." to "... it
never locks objects ...".
Section 15.10, p. 209. The "simple" case and the "searched" case both
refer to an abbreviated code excerpt, which I would assume should not be the same. They
appear to be identical, so what exactly is this saying then?
Section 15.16, p. 218, code sample after "Properties of a JavaBean can be bound to
named query parameters". The query expression begins "from foo Foo as foo
...". That seems wrong. I think it should be "from Foo as foo ...".
Section 15.18, p. 219, code sample after "It can also be useful to specify this in
the select clause ...". This section is about the row value constructor syntax.
This example doesn't appear to demonstrate a row value constructor. It just says
"select p.name from Person p".
Section 16.4, p. 224. Change "... retreive the cats with mates who's name
..." to "... retrieve the cats with mates whose name ...".
Section 16.6, p. 225. Concerning the reference to "enableLike()", it would be
useful to state exactly what this does, instead of just "use like for string
comparisons". Logic tells me that it would do "like '%value%'", but
it would be useful to confirm that.
Section 17.1.4.1, table 17.1, change "The id of an collection" to "The id
of a collection". Similarly, on the next page in the same table, change "The
element of an collection" to "The element of a collection".
Section 20.1.7, p. 258, change "... fetch profile wull be ..." to "...
fetch profile will be ...".
Section 20.1.7, p. 259, change "... but they plan is ..." to "... but the
plan is ...".
Section 20.4.1, p. 265, change "... For this reaso, ..." to "... For this
reason, ...".
Section 20.5.4, p. 268. Change "... then add thee ..." to "...then add
these ...".
Section 22.2, p. 280, change "... the link (the foreign key parent_id) from p to c
..." to "... the link (the foreign key parent_id) from c to p ...".
Chapter 25, p. 305, change "... but his approach ..." to "... but this
approach ...".
p. 306, in 'explicitly disable eager fetching using lazy="false"',
change it to "disable lazy" or "enable eager".
Section 26.4, change "targtetting" to "targeting" and change
"entitiy" to "entity". In the second "Note" change
"enhancedgenerators" to "enhanced generators".
Section 26.5, p. 311. Change "Hibernate, provides ..." to "Hibernate
provides ...".
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://opensource.atlassian.com/projects/hibernate/secure/Administrators....
-
For more information on JIRA, see: http://www.atlassian.com/software/jira