Skip to content

Commit 6214e89

Browse files
committed
Update default value documentation for IncludeWorkItemtypes, SourceFieldMappings, FixedTargetFields, and Enabled properties for clarity
1 parent 110ef52 commit 6214e89

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

src/MigrationTools.Clients.TfsObjectModel/Tools/TfsWorkItemTypeValidatorToolOptions.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,15 @@ public class TfsWorkItemTypeValidatorToolOptions : ToolOptions
1818
/// <summary>
1919
/// List of work item types which will be validated. If this list is empty, all work item types will be validated.
2020
/// </summary>
21-
/// <default>All work item types are included.</default>
21+
/// <default>null</default>
2222
public List<string> IncludeWorkItemtypes { get; set; } = [];
2323

2424
/// <summary>
2525
/// Field reference name mappings. Key is work item type name, value is dictionary of mapping source filed name to
2626
/// target field name. Target field name can be empty string to indicate that this field will not be validated in target.
2727
/// As work item type name, you can use <c>*</c> to define mappings which will be applied to all work item types.
2828
/// </summary>
29+
/// <default>null</default>
2930
public Dictionary<string, Dictionary<string, string>> SourceFieldMappings { get; set; } = [];
3031

3132
/// <summary>
@@ -43,6 +44,7 @@ public class TfsWorkItemTypeValidatorToolOptions : ToolOptions
4344
/// You can also use <c>*</c> to define fixed fields that apply to all work item types.
4445
/// </para>
4546
/// </summary>
47+
/// <default>null</default>
4648
public Dictionary<string, List<string>> FixedTargetFields { get; set; } = [];
4749

4850
/// <summary>

src/MigrationTools/Tools/Infrastructure/ToolOptions.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ public abstract class ToolOptions : IToolOptions
2424
/// <summary>
2525
/// If set to `true` then the tool will run. Set to `false` and the processor will not run.
2626
/// </summary>
27+
/// <default>true</default>
2728

2829
public bool Enabled { get; set; }
2930

0 commit comments

Comments
 (0)