Skip to content

NH-3959: fix typos in reference documentation #566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 7, 2017
Merged

NH-3959: fix typos in reference documentation #566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/reference/modules/architecture.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@
The instance was once associated with a persistence
context, but that context was closed, or the instance
was serialized to another process. It has a persistent
identity and, perhaps, a corrsponding row in the database.
identity and, perhaps, a corresponding row in the database.
For detached instances, NHibernate makes no guarantees
about the relationship between persistent identity and
CLR identity.
Expand Down
62 changes: 31 additions & 31 deletions doc/reference/modules/basic_mapping.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
<para>
This element has several optional attributes. The <literal>schema</literal> attribute
specifies that tables referred to by this mapping belong to the named schema. If specified,
tablenames will be qualified by the given schema name. If missing, tablenames will be
table names will be qualified by the given schema name. If missing, table names will be
unqualified. The <literal>default-cascade</literal> attribute specifies what cascade style
should be assumed for properties and collections which do not specify a
<literal>cascade</literal> attribute. The <literal>auto-import</literal> attribute lets us
Expand Down Expand Up @@ -230,7 +230,7 @@
<callout arearefs="class3">
<para>
<literal>discriminator-value</literal> (optional - defaults to the class name): A value
that distiguishes individual subclasses, used for polymorphic behaviour. Acceptable
that distinguishes individual subclasses, used for polymorphic behaviour. Acceptable
values include <literal>null</literal> and <literal>not null</literal>.
</para>
</callout>
Expand Down Expand Up @@ -470,7 +470,7 @@
(unsaved), distinguishing it from transient instances that were saved or loaded
in a previous session.
</para>
</callout>
</callout>
<callout arearefs="id5">
<para>
<literal>access</literal> (optional - defaults to <literal>property</literal>): The
Expand Down Expand Up @@ -570,8 +570,8 @@
use this generator with a user-supplied connection.</emphasis>
</para>
<para>
You can use the "where" parameter to specify the row to use in a table. This is useful
if you want to use a single tabel for your identifiers, with different rows for each table.
You can use the "where" parameter to specify the row to use in a table. This is useful
if you want to use a single table for your identifiers, with different rows for each table.
</para>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -700,7 +700,7 @@
The valid values for <literal>format</literal> are described in the MSDN documentation.
The default <literal>seperator</literal> is <literal>-</literal> and should rarely be
modified. The <literal>format</literal> determines if the configured
<literal>seperator</literal> can replace the default seperator used by
<literal>seperator</literal> can replace the default separator used by
the <literal>format</literal>.
</para>
</sect3>
Expand Down Expand Up @@ -776,7 +776,7 @@
<para>Starting with NHibernate release 3.3.0, there are 2 new generators which
represent a re-thinking of 2 different aspects of identifier
generation. The first aspect is database portability; the second is
optimization Optimization means that you do not have to query the
optimization. Optimization means that you do not have to query the
database for every request for a new identifier value. These two new
generators are intended to take the place of some of the named
generators described above, starting in 3.3.x. However, they are
Expand Down Expand Up @@ -1013,7 +1013,7 @@
You must instantiate an instance of the persistent class itself and populate its
identifier properties before you can <literal>load()</literal> the persistent state
associated with a composite key. We will describe a much more
convenient approach where the composite identifier is implemented as a seperate class
convenient approach where the composite identifier is implemented as a separate class
in <xref linkend="components-compositeid"/>. The attributes described below apply only
to this alternative approach:
</para>
Expand Down Expand Up @@ -1367,7 +1367,7 @@
<para>
<literal>lazy</literal> (optional - defaults to <literal>false</literal>):
Specifies that this property is lazy. A lazy property is not loaded when
the object is initially loaded, unless the fetch mode has been overriden
the object is initially loaded, unless the fetch mode has been overridden
in a specific query. Values for lazy properties are loaded when any lazy
property of the object is accessed.
</para>
Expand Down Expand Up @@ -1673,7 +1673,7 @@
specifies that the mapped columns should be included in SQL <literal>UPDATE</literal>
and/or <literal>INSERT</literal> statements. Setting both to <literal>false</literal>
allows a pure "derived" association whose value is initialized from some other
property that maps to the same colum(s) or by a trigger or other application.
property that maps to the same column(s) or by a trigger or other application.
</para>
</callout>
<callout arearefs="manytoone8">
Expand All @@ -1699,7 +1699,7 @@
<para>
<literal>optimistic-lock</literal> (optional - defaults to <literal>true</literal>):
Specifies that updates to this property do or do not require acquisition of the
optimistic lock. In other words, dertermines if a version increment should occur when
optimistic lock. In other words, determines if a version increment should occur when
this property is dirty.
</para>
</callout>
Expand Down Expand Up @@ -1889,8 +1889,8 @@
</class>]]></programlisting>

<para>
A newly saved instance of <literal>Person</literal> is then assigned the same primar
key value as the <literal>Employee</literal> instance refered with the <literal>Employee</literal>
A newly saved instance of <literal>Person</literal> is then assigned the same primary
key value as the <literal>Employee</literal> instance referred with the <literal>Employee</literal>
property of that <literal>Person</literal>.
</para>

Expand Down Expand Up @@ -2027,7 +2027,7 @@

<para>
The <literal>&lt;component&gt;</literal> element allows a <literal>&lt;parent&gt;</literal>
subelement that maps a property of the component class as a reference back to the
sub-element that maps a property of the component class as a reference back to the
containing entity.
</para>

Expand Down Expand Up @@ -2178,19 +2178,19 @@
<para>
<literal>name</literal>: The fully qualified .NET class name of the
subclass, including its assembly name.
</para>
</callout>
</para>
</callout>
<callout arearefs="subclass2">
<para>
<literal>discriminator-value</literal> (optional - defaults to the class name): A
value that distiguishes individual subclasses.
</para>
value that distinguishes individual subclasses.
</para>
</callout>
<callout arearefs="subclass3">
<para>
<literal>proxy</literal> (optional): Specifies a class or interface to use for
lazy initializing proxies.
</para>
</para>
</callout>
<callout arearefs="subclass4">
<para>
Expand Down Expand Up @@ -2247,21 +2247,21 @@
<callout arearefs="joinedsubclass1">
<para>
<literal>name</literal>: The fully qualified class name of the subclass.
</para>
</callout>
</para>
</callout>
<callout arearefs="joinedsubclass2">
<para>
<literal>proxy</literal> (optional): Specifies a class or interface to use
<literal>proxy</literal> (optional): Specifies a class or interface to use
for lazy initializing proxies.
</para>
</para>
</callout>
<callout arearefs="joinedsubclass3">
<para>
<literal>lazy</literal> (optional): Setting <literal>lazy="true"</literal> is a shortcut
equalivalent to specifying the name of the class itself as the <literal>proxy</literal>
<literal>lazy</literal> (optional): Setting <literal>lazy="true"</literal> is a shortcut
equivalent to specifying the name of the class itself as the <literal>proxy</literal>
interface.
</para>
</callout>
</callout>
</calloutlist>
</programlistingco>

Expand Down Expand Up @@ -3042,9 +3042,9 @@
<title>SQL quoted identifiers</title>
<para>
You may force NHibernate to quote an identifier in the generated SQL by enclosing the table or
column name in backticks in the mapping document. NHibernate will use the correct quotation
column name in back-ticks in the mapping document. NHibernate will use the correct quotation
style for the SQL <literal>Dialect</literal> (usually double quotes, but brackets for SQL
Server and backticks for MySQL).
Server and back-ticks for MySQL).
</para>

<programlisting><![CDATA[<class name="LineItem" table="`Line Item`">
Expand All @@ -3059,8 +3059,8 @@
<title>Modular mapping files</title>
<para>
It is possible to define <literal>subclass</literal> and <literal>joined-subclass</literal>
mappings in seperate mapping documents, directly beneath <literal>hibernate-mapping</literal>.
This allows you to extend a class hierachy just by adding a new mapping file. You must
mappings in separate mapping documents, directly beneath <literal>hibernate-mapping</literal>.
This allows you to extend a class hierarchy just by adding a new mapping file. You must
specify an <literal>extends</literal> attribute in the subclass mapping, naming a previously
mapped superclass. Use of this feature makes the ordering of the mapping documents important!
</para>
Expand All @@ -3087,7 +3087,7 @@
issues a select afterwards to retrieve the generated values.
</para>
<para>
Properties marked as generated must additionally be non-insertable and non-updateable.
Properties marked as generated must additionally be non-insertable and non-updatable.
Only <xref linkend="mapping-declaration-version">versions</xref>,
<xref linkend="mapping-declaration-timestamp">timestamps</xref>, and
<xref linkend="mapping-declaration-property">simple properties</xref> can be marked as
Expand Down
10 changes: 5 additions & 5 deletions doc/reference/modules/batch.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ session.Close();]]></programlisting>

<para id="disablebatching" revision="1">
Note that NHibernate disables insert batching at the ADO level transparently if you
use an <literal>identiy</literal> identifier generator.
use an <literal>identity</literal> identifier generator.
</para>

<para>
Expand Down Expand Up @@ -160,7 +160,7 @@ session.Close();]]></programlisting>
<para>
No <link linkend="queryhql-joins-forms">joins</link> (either implicit or explicit)
can be specified in a bulk HQL query. Sub-queries may be used in the where-clause;
the subqueries, themselves, may contain joins.
the sub-queries, themselves, may contain joins.
</para>
</listitem>
<listitem>
Expand Down Expand Up @@ -236,7 +236,7 @@ session.Close();]]></programlisting>
number indicates the number of actual entities affected by the statement. Going back to the
example of joined-subclass, a delete against one of the subclasses may actually result
in deletes against not just the table to which that subclass is mapped, but also the "root"
table and potentially joined-subclass tables further down the inheritence hierarchy.
table and potentially joined-subclass tables further down the inheritance hierarchy.
</para>

<para>
Expand All @@ -251,9 +251,9 @@ session.Close();]]></programlisting>
Only the INSERT INTO ... SELECT ... form is supported; not the INSERT INTO ... VALUES ... form.
</para>
<para>
The properties_list is analogous to the <literal>column speficiation</literal>
The properties_list is analogous to the <literal>column specification</literal>
in the SQL <literal>INSERT</literal> statement. For entities involved in mapped
inheritence, only properties directly defined on that given class-level can be
inheritance, only properties directly defined on that given class-level can be
used in the properties_list. Superclass properties are not allowed; and subclass
properties do not make sense. In other words, <literal>INSERT</literal>
statements are inherently non-polymorphic.
Expand Down
10 changes: 5 additions & 5 deletions doc/reference/modules/best_practices.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,11 +122,11 @@
<listitem>
<para>
Database Transactions have to be as short as possible for best scalability. However, it is often
neccessary to implement long running Application Transactions, a single unit-of-work from the
necessary to implement long running Application Transactions, a single unit-of-work from the
point of view of a user. This Application Transaction might span several client requests and
response cycles. Either use Detached Objects or, in two tiered architectures, simply disconnect
the NHibernate Session from the ADO.NET connection and reconnect it for each subsequent request.
Never use a single Session for more than one Application Transaction usecase, otherwise, you
Never use a single Session for more than one Application Transaction use-case, otherwise, you
will run into stale data.
</para>
</listitem>
Expand Down Expand Up @@ -162,7 +162,7 @@
<para>
Hide (NHibernate) data-access code behind an interface. Combine the <emphasis>DAO</emphasis> and
<emphasis>Thread Local Session</emphasis> patterns. You can even have some classes persisted by
handcoded ADO.NET, associated to NHibernate via an <literal>IUserType</literal>. (This advice is
hand-coded ADO.NET, associated to NHibernate via an <literal>IUserType</literal>. (This advice is
intended for "sufficiently large" applications; it is not appropriate for an application with
five tables!)
</para>
Expand All @@ -189,11 +189,11 @@
<term>Don't use exotic association mappings.</term>
<listitem>
<para>
Good usecases for a real many-to-many associations are rare. Most of the time you need
Good use-cases for a real many-to-many associations are rare. Most of the time you need
additional information stored in the "link table". In this case, it is much better to
use two one-to-many associations to an intermediate link class. In fact, we think that
most associations are one-to-many and many-to-one, you should be careful when using any
other association style and ask yourself if it is really neccessary.
other association style and ask yourself if it is really necessary.
</para>
</listitem>
</varlistentry>
Expand Down
Loading