Documentation suggestions & typos

naasking · **Joined:** Thu May 26, 2005 1:00 pm **Posts:** 29

Just a few issues I ran across when learning NHibernate (these are relatively trivial issues needing a fix):

A note under the "disciminator" and "version" sections to point out that those declarations must immediately follow the "id" declaration, and precede any "property" declarations would have been handy (unless this isn't the desired behaviour, in which case this might be a bug).
A brief reference as to what persistent collections are available and what .Net collections they map to would have been helpful. Something like the tables describing the correspondance between NHibernate data types, database types and .Net types (ie. Tables 4.3, 4.4, 4.5).
A note pointing out the assumptions underlying "version/timestamp" fields would have saved me a few hours of work. Ah, the tribulations of inheriting someone else's database schema... :?
"Using cascading update()" section has a typo: "Suppose we loaded up a Parent in one ISession, mode some changes..." (probably should be "made some changes...")
In the introduction to "Chapter 6. Association Mappings", "...associations by wheter or not...", should be "whether or not"
Same section, "...considered good practive in traditional...", should be "practice"
Under "Chapter 5. Collection Mapping", "Persistence Collections" section, "Properties of type System.Collections.ILst may", should be "IList"
Same section "persistent object and automattically deleted...", should be "automatically"
Same section, "but make sure you understand the semantic of bidirectional associations...", should be "semantics"
Same section, "all basic types, custome types", should be "custom"

I'm sure I ran across more typos and minor issues, but I don't recall them at the moment. That's all for now! Thanks for the great ORM. Back to work for me. :)

KPixel · **Posted:** Thu Oct 20, 2005 7:48 am

Thanks for this suggestions :wink:

We are currently working on merging NHibernate Documentation with Hibernate one; so we will probably integrate this changes in the result.

naasking · **Joined:** Thu May 26, 2005 1:00 pm **Posts:** 29

Something else which just bit me:

Under composite-id section, explain that when specifying the many-to-one mapping of a composite class, that the order of the columns must match the order specified in the composite-id definition

For instance:

Code:

<class name="CompositeClass" table="CompositeClasses">
   <composite-id>
      <key-property name="col1" column="Col1" />
      <key-property name="data2" column="Data2" />
   </composite-id>
</class>

<!-- mapped class that will fail in loading CompositeClass -->
<class name="FailedBusinessObject" table="FailedBusinessObjects">
    <many-to-one name="compositeClass">
        <column name="Data2" />
        <column name="Col1" />
   </many-to-one>
</class>

<!-- mapped class that will succeed in loading CompositeClass -->
<class name="BusinessObject" table="BusinessObjects">
    <many-to-one name="compositeClass">
        <column name="Col1" />
        <column name="Data2" />
   </many-to-one>
</class>