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

Sorin Postelnicu (JIRA) noreply at atlassian.com
Thu Mar 18 14:49:31 EDT 2010


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

        


More information about the hibernate-issues mailing list