[hibernate-issues] [Hibernate-JIRA] Commented: (HHH-5022) Small documentation improvements in chapter 6

[Strong Liu (JIRA)]

    [ http://opensource.atlassian.com/projects/hibernate/browse/HHH-5022?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=35882#action_35882 ] 

Strong Liu commented on HHH-5022:
---------------------------------

Sorin,

Just FYI, it is much better if these are "svn diff" version, then we can clearly find which part you cnanged :)

e.g. 
--------
localhost:manual stliu$ svn diff
Index: src/main/docbook/en-US/content/query_hql.xml
===================================================================
--- src/main/docbook/en-US/content/query_hql.xml	(revision 19023)
+++ src/main/docbook/en-US/content/query_hql.xml	(working copy)
@@ -1147,7 +1147,7 @@
         </para>
 
         <programlisting><![CDATA[select usr.id, usr.name
-from User usr.name
+from User usr
     join usr.messages msg
 group by usr.id, usr.name
 having count(msg) >= 1]]></programlisting>
Index: src/main/docbook/en-US/content/persistent_classes.xml
===================================================================
--- src/main/docbook/en-US/content/persistent_classes.xml	(revision 19023)
+++ src/main/docbook/en-US/content/persistent_classes.xml	(working copy)
@@ -427,7 +427,6 @@
 
         <programlisting role="JAVA"><![CDATA[Session s = openSession();
 Transaction tx = s.beginTransaction();
-Session s = openSession();
 
 // Create a customer
 Map david = new HashMap();


> Small documentation improvements in chapter 6
> ---------------------------------------------
>
>                 Key: HHH-5022
>                 URL: http://opensource.atlassian.com/projects/hibernate/browse/HHH-5022
>             Project: Hibernate Core
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 3.3.2
>            Reporter: Sorin Postelnicu
>            Priority: Minor
>
> In section 6.2.3, I think it would be clearer/more correct if the final phrase would be like this: "A bag does not retain its order when it is persisted to the database, but it can be optionally sorted or ordered when it is retrieved from the database."
> Also, at the end of section 14.3, before the paragraph with "The fetch construct cannot be used in queries called using...", it would be good if you add something like: "<strong>Limitations:</strong>", so that people can easily spot them in the documentation and be aware of them.
> And also the correct sentence should be "Fetch should NOT be used together with setMaxResults() or setFirstResult(), as these operations..." - this is a minor typo, but with major implications :)
> (I know that these are some of the frequent issues encountered by people who are just learning or have little experience with Hibernate)
> Also some small typos:
> In section 14.16:
>     select usr.id, usr.name
>     from User usr.name
>         join usr.messages msg
>     group by usr.id, usr.name
>     having count(msg) >= 1
> should be
>     select usr.id, usr.name
>     from User usr
>         join usr.messages msg
>     group by usr.id, usr.name
>     having count(msg) >= 1
> And in section 4.4:
>         Session s = openSession();
>         Transaction tx = s.beginTransaction();
>         Session s = openSession();
> should be
>         Session s = openSession();
>         Transaction tx = s.beginTransaction();

-- 
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.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira