Skip to content
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

Jump to bottom

Correct a/an in XML docs #25385

Merged
merged 1 commit into from
Aug 2, 2021
Merged

Correct a/an in XML docs #25385

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 src/EFCore.Abstractions/ObservableCollectionExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ namespace Microsoft.EntityFrameworkCore
public static class ObservableCollectionExtensions
{
/// <summary>
/// Returns an <see cref="BindingList{T}" /> implementation that stays in sync with the given
/// Returns a <see cref="BindingList{T}" /> implementation that stays in sync with the given
/// <see cref="ObservableCollection{T}" />.
/// </summary>
/// <typeparam name="T"> The element type. </typeparam>
Expand Down
54 changes: 27 additions & 27 deletions src/EFCore.Relational/Migrations/MigrationBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -567,7 +567,7 @@ public virtual AlterOperationBuilder<AlterTableOperation> AlterTable(
}

/// <summary>
/// Builds an <see cref="CreateIndexOperation" /> to create a new index.
/// Builds a <see cref="CreateIndexOperation" /> to create a new index.
/// </summary>
/// <param name="name"> The index name. </param>
/// <param name="table"> The table that contains the index. </param>
Expand All @@ -592,7 +592,7 @@ public virtual OperationBuilder<CreateIndexOperation> CreateIndex(
filter);

/// <summary>
/// Builds an <see cref="CreateIndexOperation" /> to create a new composite (multi-column) index.
/// Builds a <see cref="CreateIndexOperation" /> to create a new composite (multi-column) index.
/// </summary>
/// <param name="name"> The index name. </param>
/// <param name="table"> The table that contains the index. </param>
Expand Down Expand Up @@ -644,7 +644,7 @@ public virtual OperationBuilder<EnsureSchemaOperation> EnsureSchema(
}

/// <summary>
/// Builds an <see cref="CreateSequenceOperation" /> to create a new sequence.
/// Builds a <see cref="CreateSequenceOperation" /> to create a new sequence.
/// </summary>
/// <param name="name"> The sequence name. </param>
/// <param name="schema"> The schema that contains the sequence, or <see langword="null" /> to use the default schema. </param>
Expand All @@ -665,7 +665,7 @@ public virtual OperationBuilder<CreateSequenceOperation> CreateSequence(
=> CreateSequence<long>(name, schema, startValue, incrementBy, minValue, maxValue, cyclic);

/// <summary>
/// Builds an <see cref="CreateSequenceOperation" /> to create a new sequence.
/// Builds a <see cref="CreateSequenceOperation" /> to create a new sequence.
/// </summary>
/// <typeparam name="T"> The CLR type of the values generated by the sequence. </typeparam>
/// <param name="name"> The sequence name. </param>
Expand Down Expand Up @@ -753,7 +753,7 @@ public virtual OperationBuilder<AddCheckConstraintOperation> AddCheckConstraint(
}

/// <summary>
/// Builds an <see cref="CreateTableOperation" /> to create a new table.
/// Builds a <see cref="CreateTableOperation" /> to create a new table.
/// </summary>
/// <typeparam name="TColumns"> Type of a typically anonymous type for building columns. </typeparam>
/// <param name="name"> The name of the table. </param>
Expand Down Expand Up @@ -807,7 +807,7 @@ public virtual CreateTableBuilder<TColumns> CreateTable<TColumns>(
}

/// <summary>
/// Builds an <see cref="DropColumnOperation" /> to drop an existing column.
/// Builds a <see cref="DropColumnOperation" /> to drop an existing column.
/// </summary>
/// <param name="name"> The name of the column to drop. </param>
/// <param name="table"> The table that contains the column. </param>
Expand All @@ -833,7 +833,7 @@ public virtual OperationBuilder<DropColumnOperation> DropColumn(
}

/// <summary>
/// Builds an <see cref="DropForeignKeyOperation" /> to drop an existing foreign key constraint.
/// Builds a <see cref="DropForeignKeyOperation" /> to drop an existing foreign key constraint.
/// </summary>
/// <param name="name"> The name of the foreign key constraint to drop. </param>
/// <param name="table"> The table that contains the foreign key. </param>
Expand All @@ -859,7 +859,7 @@ public virtual OperationBuilder<DropForeignKeyOperation> DropForeignKey(
}

/// <summary>
/// Builds an <see cref="DropIndexOperation" /> to drop an existing index.
/// Builds a <see cref="DropIndexOperation" /> to drop an existing index.
/// </summary>
/// <param name="name"> The name of the index to drop. </param>
/// <param name="table"> The table that contains the index. </param>
Expand All @@ -884,7 +884,7 @@ public virtual OperationBuilder<DropIndexOperation> DropIndex(
}

/// <summary>
/// Builds an <see cref="DropPrimaryKeyOperation" /> to drop an existing primary key.
/// Builds a <see cref="DropPrimaryKeyOperation" /> to drop an existing primary key.
/// </summary>
/// <param name="name"> The name of the primary key constraint to drop. </param>
/// <param name="table"> The table that contains the key. </param>
Expand All @@ -910,7 +910,7 @@ public virtual OperationBuilder<DropPrimaryKeyOperation> DropPrimaryKey(
}

/// <summary>
/// Builds an <see cref="DropSchemaOperation" /> to drop an existing schema.
/// Builds a <see cref="DropSchemaOperation" /> to drop an existing schema.
/// </summary>
/// <param name="name"> The name of the schema to drop. </param>
/// <returns> A builder to allow annotations to be added to the operation. </returns>
Expand All @@ -926,7 +926,7 @@ public virtual OperationBuilder<DropSchemaOperation> DropSchema(
}

/// <summary>
/// Builds an <see cref="DropSequenceOperation" /> to drop an existing sequence.
/// Builds a <see cref="DropSequenceOperation" /> to drop an existing sequence.
/// </summary>
/// <param name="name"> The name of the sequence to drop. </param>
/// <param name="schema"> The schema that contains the sequence, or <see langword="null" /> to use the default schema. </param>
Expand All @@ -944,7 +944,7 @@ public virtual OperationBuilder<DropSequenceOperation> DropSequence(
}

/// <summary>
/// Builds an <see cref="DropCheckConstraintOperation" /> to drop an existing check constraint.
/// Builds a <see cref="DropCheckConstraintOperation" /> to drop an existing check constraint.
/// </summary>
/// <param name="name"> The name of the check constraint to drop. </param>
/// <param name="table"> The name of the table for the check constraint to drop. </param>
Expand All @@ -969,7 +969,7 @@ public virtual OperationBuilder<DropCheckConstraintOperation> DropCheckConstrain
}

/// <summary>
/// Builds an <see cref="DropTableOperation" /> to drop an existing table.
/// Builds a <see cref="DropTableOperation" /> to drop an existing table.
/// </summary>
/// <param name="name"> The name of the table to drop. </param>
/// <param name="schema"> The schema that contains the table, or <see langword="null" /> to use the default schema. </param>
Expand All @@ -987,7 +987,7 @@ public virtual OperationBuilder<DropTableOperation> DropTable(
}

/// <summary>
/// Builds an <see cref="DropUniqueConstraintOperation" /> to drop an existing unique constraint.
/// Builds a <see cref="DropUniqueConstraintOperation" /> to drop an existing unique constraint.
/// </summary>
/// <param name="name"> The name of the constraint to drop. </param>
/// <param name="table"> The table that contains the constraint. </param>
Expand All @@ -1013,7 +1013,7 @@ public virtual OperationBuilder<DropUniqueConstraintOperation> DropUniqueConstra
}

/// <summary>
/// Builds an <see cref="RenameColumnOperation" /> to rename an existing column.
/// Builds a <see cref="RenameColumnOperation" /> to rename an existing column.
/// </summary>
/// <param name="name"> The name of the column to be renamed.</param>
/// <param name="table"> The table that contains the column. </param>
Expand Down Expand Up @@ -1043,7 +1043,7 @@ public virtual OperationBuilder<RenameColumnOperation> RenameColumn(
}

/// <summary>
/// Builds an <see cref="RenameIndexOperation" /> to rename an existing index.
/// Builds a <see cref="RenameIndexOperation" /> to rename an existing index.
/// </summary>
/// <param name="name"> The name of the index to be renamed.</param>
/// <param name="newName"> The new name for the column. </param>
Expand Down Expand Up @@ -1073,7 +1073,7 @@ public virtual OperationBuilder<RenameIndexOperation> RenameIndex(
}

/// <summary>
/// Builds an <see cref="RenameSequenceOperation" /> to rename an existing sequence.
/// Builds a <see cref="RenameSequenceOperation" /> to rename an existing sequence.
/// </summary>
/// <param name="name"> The name of the sequence to be renamed.</param>
/// <param name="schema"> The schema that contains the sequence, or <see langword="null" /> to use the default schema. </param>
Expand Down Expand Up @@ -1101,7 +1101,7 @@ public virtual OperationBuilder<RenameSequenceOperation> RenameSequence(
}

/// <summary>
/// Builds an <see cref="RenameTableOperation" /> to rename an existing table.
/// Builds a <see cref="RenameTableOperation" /> to rename an existing table.
/// </summary>
/// <param name="name"> The name of the table to be renamed.</param>
/// <param name="schema"> The schema that contains the table, or <see langword="null" /> to use the default schema. </param>
Expand Down Expand Up @@ -1129,7 +1129,7 @@ public virtual OperationBuilder<RenameTableOperation> RenameTable(
}

/// <summary>
/// Builds an <see cref="RestartSequenceOperation" /> to re-start an existing sequence.
/// Builds a <see cref="RestartSequenceOperation" /> to re-start an existing sequence.
/// </summary>
/// <param name="name"> The name of the sequence.</param>
/// <param name="startValue"> The value at which the sequence will start, defaulting to 1. </param>
Expand Down Expand Up @@ -1350,7 +1350,7 @@ private OperationBuilder<InsertDataOperation> InsertDataInternal(
}

/// <summary>
/// Builds an <see cref="DeleteDataOperation" /> to delete a single row of seed data.
/// Builds a <see cref="DeleteDataOperation" /> to delete a single row of seed data.
/// </summary>
/// <param name="table"> The table from which the data will be deleted. </param>
/// <param name="keyColumn"> The name of the key column used to select the row to delete. </param>
Expand All @@ -1365,7 +1365,7 @@ public virtual OperationBuilder<DeleteDataOperation> DeleteData(
=> DeleteData(table, new[] { Check.NotNull(keyColumn, nameof(keyValue)) }, new[] { keyValue }, schema);

/// <summary>
/// Builds an <see cref="DeleteDataOperation" /> to delete a single row of seed data.
/// Builds a <see cref="DeleteDataOperation" /> to delete a single row of seed data.
/// </summary>
/// <param name="table"> The table from which the data will be deleted. </param>
/// <param name="keyColumn"> The name of the key column used to select the row to delete. </param>
Expand All @@ -1389,7 +1389,7 @@ public virtual OperationBuilder<DeleteDataOperation> DeleteData(
schema);

/// <summary>
/// Builds an <see cref="DeleteDataOperation" /> to delete a single row of seed data from
/// Builds a <see cref="DeleteDataOperation" /> to delete a single row of seed data from
/// a table with a composite (multi-column) key.
/// </summary>
/// <param name="table"> The table from which the data will be deleted. </param>
Expand All @@ -1409,7 +1409,7 @@ public virtual OperationBuilder<DeleteDataOperation> DeleteData(
schema);

/// <summary>
/// Builds an <see cref="DeleteDataOperation" /> to delete a single row of seed data from
/// Builds a <see cref="DeleteDataOperation" /> to delete a single row of seed data from
/// a table with a composite (multi-column) key.
/// </summary>
/// <param name="table"> The table from which the data will be deleted. </param>
Expand All @@ -1434,7 +1434,7 @@ public virtual OperationBuilder<DeleteDataOperation> DeleteData(
schema);

/// <summary>
/// Builds an <see cref="DeleteDataOperation" /> to delete multiple rows of seed data.
/// Builds a <see cref="DeleteDataOperation" /> to delete multiple rows of seed data.
/// </summary>
/// <param name="table"> The table from which the data will be deleted. </param>
/// <param name="keyColumn"> The name of the key column used to select the row to delete. </param>
Expand All @@ -1453,7 +1453,7 @@ public virtual OperationBuilder<DeleteDataOperation> DeleteData(
schema);

/// <summary>
/// Builds an <see cref="DeleteDataOperation" /> to delete multiple rows of seed data.
/// Builds a <see cref="DeleteDataOperation" /> to delete multiple rows of seed data.
/// </summary>
/// <param name="table"> The table from which the data will be deleted. </param>
/// <param name="keyColumn"> The name of the key column used to select the row to delete. </param>
Expand All @@ -1477,7 +1477,7 @@ public virtual OperationBuilder<DeleteDataOperation> DeleteData(
schema);

/// <summary>
/// Builds an <see cref="DeleteDataOperation" /> to delete multiple rows of seed data from
/// Builds a <see cref="DeleteDataOperation" /> to delete multiple rows of seed data from
/// a table with a composite (multi-column) key.
/// </summary>
/// <param name="table"> The table from which the data will be deleted. </param>
Expand All @@ -1496,7 +1496,7 @@ public virtual OperationBuilder<DeleteDataOperation> DeleteData(
=> DeleteDataInternal(table, keyColumns, null, keyValues, schema);

/// <summary>
/// Builds an <see cref="DeleteDataOperation" /> to delete multiple rows of seed data from
/// Builds a <see cref="DeleteDataOperation" /> to delete multiple rows of seed data from
/// a table with a composite (multi-column) key.
/// </summary>
/// <param name="table"> The table from which the data will be deleted. </param>
Expand Down
2 changes: 1 addition & 1 deletion src/EFCore.Relational/Migrations/MigrationsSqlGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1346,7 +1346,7 @@ protected virtual void SequenceOptions(
}

/// <summary>
/// Generates a SQL fragment for the column definitions in an <see cref="CreateTableOperation" />.
/// Generates a SQL fragment for the column definitions in a <see cref="CreateTableOperation" />.
/// </summary>
/// <param name="operation"> The operation. </param>
/// <param name="model"> The target model which may be <see langword="null" /> if the operations exist without a model. </param>
Expand Down
6 changes: 3 additions & 3 deletions src/EFCore.Relational/Update/UpdateSqlGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ protected virtual void AppendInsertCommandHeader(
}

/// <summary>
/// Appends a SQL fragment for starting an <c>DELETE</c>.
/// Appends a SQL fragment for starting a <c>DELETE</c>.
/// </summary>
/// <param name="commandStringBuilder"> The builder to which the SQL should be appended. </param>
/// <param name="name"> The name of the table. </param>
Expand Down Expand Up @@ -351,7 +351,7 @@ protected virtual void AppendUpdateCommandHeader(
}

/// <summary>
/// Appends a SQL fragment for starting an <c>SELECT</c>.
/// Appends a SQL fragment for starting a <c>SELECT</c>.
/// </summary>
/// <param name="commandStringBuilder"> The builder to which the SQL should be appended. </param>
/// <param name="operations"> The operations representing the data to be read. </param>
Expand All @@ -371,7 +371,7 @@ protected virtual void AppendSelectCommandHeader(
}

/// <summary>
/// Appends a SQL fragment for starting an <c>FROM</c> clause.
/// Appends a SQL fragment for starting a <c>FROM</c> clause.
/// </summary>
/// <param name="commandStringBuilder"> The builder to which the SQL should be appended. </param>
/// <param name="name"> The name of the table. </param>
Expand Down
2 changes: 1 addition & 1 deletion src/EFCore.Sqlite.Core/Migrations/SqliteMigrationsSqlGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -724,7 +724,7 @@ protected override void Generate(
}

/// <summary>
/// Generates a SQL fragment for the column definitions in an <see cref="CreateTableOperation" />.
/// Generates a SQL fragment for the column definitions in a <see cref="CreateTableOperation" />.
/// </summary>
/// <param name="operation"> The operation. </param>
/// <param name="model"> The target model which may be <see langword="null" /> if the operations exist without a model. </param>
Expand Down
2 changes: 1 addition & 1 deletion src/EFCore/ChangeTracking/LocalView.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -435,7 +435,7 @@ private void OnCollectionChanged(NotifyCollectionChangedAction action, object it
=> OnCollectionChanged(new NotifyCollectionChangedEventArgs(action, item));

/// <summary>
/// Returns an <see cref="BindingList{T}" /> implementation that stays in sync with this collection.
/// Returns a <see cref="BindingList{T}" /> implementation that stays in sync with this collection.
/// Use this for WinForms data binding.
/// </summary>
/// <returns> The binding list. </returns>
Expand Down
2 changes: 1 addition & 1 deletion src/EFCore/DbSet.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ public virtual IQueryable<TEntity> AsQueryable()

/// <summary>
/// <para>
/// Gets an <see cref="LocalView{TEntity}" /> that represents a local view of all Added, Unchanged,
/// Gets a <see cref="LocalView{TEntity}" /> that represents a local view of all Added, Unchanged,
/// and Modified entities in this set.
/// </para>
/// <para>
Expand Down
4 changes: 2 additions & 2 deletions src/EFCore/Extensions/EntityFrameworkQueryableExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ public static Task<int> CountAsync<TSource>(
}

/// <summary>
/// Asynchronously returns an <see cref="long" /> that represents the total number of elements in a sequence.
/// Asynchronously returns a <see cref="long" /> that represents the total number of elements in a sequence.
/// </summary>
/// <remarks>
/// Multiple active operations on the same context instance are not supported. Use <see langword="await" /> to ensure
Expand All @@ -220,7 +220,7 @@ public static Task<long> LongCountAsync<TSource>(
}

/// <summary>
/// Asynchronously returns an <see cref="long" /> that represents the number of elements in a sequence
/// Asynchronously returns a <see cref="long" /> that represents the number of elements in a sequence
/// that satisfy a condition.
/// </summary>
/// <remarks>
Expand Down