Skip to content

Commit 2b7fbef

Browse files
committed
Tweak documentation wording.
1 parent b5b7d6b commit 2b7fbef

3 files changed

Lines changed: 28 additions & 26 deletions

File tree

PSql.Deploy.Engine/Core/TargetGroup.cs

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,25 @@
44
namespace PSql.Deploy;
55

66
/// <summary>
7-
/// Represents a set of target databases with specified parallelism limits.
7+
/// Represents a group of target databases with specified parallelism limits.
88
/// </summary>
99
public class TargetGroup
1010
{
1111
/// <summary>
1212
/// Initializes a new <see cref="TargetGroup"/> instance.
1313
/// </summary>
1414
/// <param name="targets">
15-
/// The targets in the set.
15+
/// The targets in the group.
1616
/// </param>
1717
/// <param name="name">
18-
/// An optional name for the set. If provided, PSql.Deploy uses the name
19-
/// in command output and logs.
18+
/// An optional name for the group. If provided, PSql.Deploy uses the
19+
/// name in command output and logs.
2020
/// </param>
2121
/// <param name="maxParallelism">
22-
/// The maximum degree of parallelism across all targets in the set.
23-
/// The special value <c>0</c> indicates parallelism equal to the count
24-
/// of logical processors on the current machine. Cannot be negative.
22+
/// The maximum degree of parallelism across all target databases in the
23+
/// group. The special value <c>0</c> indicates parallelism equal to the
24+
/// count of logical processors on the current machine. Cannot be
25+
/// negative.
2526
/// </param>
2627
/// <param name="maxParallelismPerTarget">
2728
/// The maximum degree of parallelism per target. The special value
@@ -60,12 +61,12 @@ public TargetGroup(
6061
}
6162

6263
/// <summary>
63-
/// Gets the targets in the set.
64+
/// Gets the target databases in the group.
6465
/// </summary>
6566
public IReadOnlyList<Target> Targets { get; }
6667

6768
/// <summary>
68-
/// Gets the descriptive name for the set, if any.
69+
/// Gets the descriptive name for the group, if any.
6970
/// </summary>
7071
public string? Name { get; }
7172

PSql.Deploy/Commands/NewSqlTargetDatabaseGroupCommand.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ public class NewSqlTargetDatabaseGroupCommand : PSCmdlet
1212
{
1313
/// <summary>
1414
/// <b>-Target:</b>
15-
/// Objects specifying the databases in the target set.
15+
/// Objects specifying the databases in the target database group.
1616
/// </summary>
1717
[Parameter(Position = 0, Mandatory = true, ValueFromPipeline = true)]
1818
[ValidateNotNullOrEmpty]
1919
public SqlTargetDatabase[]? Target { get; set; }
2020

2121
/// <summary>
2222
/// <b>-Name:</b>
23-
/// Informational name of the target set.
23+
/// Informational name of the target database group.
2424
/// </summary>
2525
[Parameter(Position = 1)]
2626
[ValidateNotNullOrEmpty]

PSql.Deploy/Data/SqlTargetDatabaseGroup.cs

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@ namespace PSql.Deploy;
77
using System.Diagnostics;
88

99
/// <summary>
10-
/// Represents a set of target databases with specified parallelism limits.
10+
/// Represents a group of target databases with specified parallelism limits.
1111
/// </summary>
1212
[DebuggerDisplay(@"\{{Name}, Count = {Targets.Count}\}")]
1313
public class SqlTargetDatabaseGroup
1414
{
1515
private readonly E.TargetGroup _inner;
1616

1717
/// <summary>
18-
/// Initializes a new <see cref="SqlTargetDatabaseGroup"/> instance by converting from
19-
/// the specified object.
18+
/// Initializes a new <see cref="SqlTargetDatabaseGroup"/> instance by
19+
/// converting from the specified object.
2020
/// </summary>
2121
/// <param name="obj">
2222
/// The object to convert into a <see cref="SqlTargetDatabaseGroup"/>.
@@ -36,24 +36,25 @@ public SqlTargetDatabaseGroup(object obj)
3636
}
3737

3838
/// <summary>
39-
/// Initializes a new <see cref="SqlTargetDatabaseGroup"/> instance with the specified
40-
/// values.
39+
/// Initializes a new <see cref="SqlTargetDatabaseGroup"/> instance with
40+
/// the specified values.
4141
/// </summary>
4242
/// <param name="targets">
43-
/// The targets in the set.
43+
/// The target databases in the group.
4444
/// </param>
4545
/// <param name="name">
46-
/// An optional name for the set. If provided, PSql.Deploy uses the name
47-
/// in command output and logs.
46+
/// An optional name for the group. If provided, PSql.Deploy uses the
47+
/// name in command output and logs.
4848
/// </param>
4949
/// <param name="maxParallelism">
50-
/// The maximum degree of parallelism across all targets in the set.
51-
/// The special value <c>0</c> indicates parallelism equal to the count
52-
/// of logical processors on the current machine. Cannot be negative.
50+
/// The maximum degree of parallelism across all target databases in the
51+
/// group. The special value <c>0</c> indicates parallelism equal to the
52+
/// count of logical processors on the current machine. Cannot be
53+
/// negative.
5354
/// </param>
5455
/// <param name="maxParallelismPerTarget">
55-
/// The maximum degree of parallelism per target. The special value
56-
/// <c>0</c> indicates parallelism equal to the count of logical
56+
/// The maximum degree of parallelism per target database. The special
57+
/// value <c>0</c> indicates parallelism equal to the count of logical
5758
/// processors on the current machine. Cannot be negative.
5859
/// </param>
5960
/// <exception cref="ArgumentNullException">
@@ -82,7 +83,7 @@ public SqlTargetDatabaseGroup(
8283
}
8384

8485
/// <summary>
85-
/// Gets the inner target set wrapped by this object.
86+
/// Gets the inner target database group wrapped by this object.
8687
/// </summary>
8788
internal E.TargetGroup InnerGroup => _inner;
8889

@@ -92,7 +93,7 @@ public SqlTargetDatabaseGroup(
9293
public IReadOnlyList<SqlTargetDatabase> Targets { get; }
9394

9495
/// <summary>
95-
/// Gets the descriptive name for the set, if any.
96+
/// Gets the descriptive name for the group, if any.
9697
/// </summary>
9798
public string? Name => _inner.Name;
9899

0 commit comments

Comments
 (0)