Skip to content

Commit da3c377

Browse files
CodingFlowCodingFlow
committed
Rename examples to remove "Basic" from their name.
1 parent 322d78c commit da3c377

11 files changed

Lines changed: 48 additions & 49 deletions

‎CodingFlow.FluentValidation/FluentValidation.cs‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
namespace CodingFlow.FluentValidation;
22

33
/// <summary>
4-
/// The returned chained object for the fluent API. Do not use the methods
5-
/// on this type directly.
4+
/// The returned chained object for the fluent API.
65
/// </summary>
76
/// <typeparam name="T">Input type.</typeparam>
87
public class FluentValidation<T>

Examples/BetweenExclusiveBasicExample.cs renamed to Examples/BetweenExclusiveExample.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33

44
namespace Examples;
55

6-
internal class BetweenExclusiveBasicExample
6+
internal class BetweenExclusiveExample
77
{
88
public void Run()
99
{
1010
var input = 11;
1111

12-
// begin-snippet: BetweenExclusiveBasicExample
12+
// begin-snippet: BetweenExclusiveExample
1313
RuleFor(input)
1414
.BetweenExclusive(6, 14)
1515
.Result();

Examples/BetweenInclusiveBasicExample.cs renamed to Examples/BetweenInclusiveExample.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33

44
namespace Examples;
55

6-
internal class BetweenInclusiveBasicExample
6+
internal class BetweenInclusiveExample
77
{
88
public void Run()
99
{
1010
var input = 11;
1111

12-
// begin-snippet: BetweenInclusiveBasicExample
12+
// begin-snippet: BetweenInclusiveExample
1313
RuleFor(input)
1414
.BetweenInclusive(6, 14)
1515
.Result();

Examples/EqualBasicExample.cs renamed to Examples/EqualExample.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33

44
namespace Examples;
55

6-
internal class EqualBasicExample
6+
internal class EqualExample
77
{
88
public void Run()
99
{
1010
var input = 11;
1111

12-
// begin-snippet: EqualBasicExample
12+
// begin-snippet: EqualExample
1313
RuleFor(input)
1414
.Equal(8)
1515
.Result();

Examples/IsGuidBasicExample.cs renamed to Examples/IsGuidExample.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33

44
namespace Examples;
55

6-
internal class IsGuidBasicExample
6+
internal class IsGuidExample
77
{
88
public void Run()
99
{
1010
var input = "some string";
1111

12-
// begin-snippet: IsGuidBasicExample
12+
// begin-snippet: IsGuidExample
1313
RuleFor(input)
1414
.IsGuid()
1515
.Result();

‎Examples/MatchesExample.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ public void Run()
99
{
1010
var input = "some string";
1111

12-
// begin-snippet: MatchesBasicExample
12+
// begin-snippet: MatchesExample
1313
RuleFor(input)
1414
.Matches("cat")
1515
.Result();

Examples/MustBasicExample.cs renamed to Examples/MustExample.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33

44
namespace Examples;
55

6-
internal class MustBasicExample
6+
internal class MustExample
77
{
88
public void Run()
99
{
1010
var input = 11;
1111

12-
// begin-snippet: MustBasicExample
12+
// begin-snippet: MustExample
1313
RuleFor(input)
1414
.Must(input => input == 7)
1515
.Result();

Examples/NotEmptyBasicExample.cs renamed to Examples/NotEmptyExample.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33

44
namespace Examples;
55

6-
internal class NotEmptyBasicExample
6+
internal class NotEmptyExample
77
{
88
public void Run()
99
{
1010
var input = 11;
1111

12-
// begin-snippet: NotEmptyBasicExample
12+
// begin-snippet: NotEmptyExample
1313
RuleFor(input)
1414
.NotEmpty()
1515
.Result();

Examples/WithMessageBasicExample.cs renamed to Examples/WithMessageExample.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44

55
namespace Examples;
66

7-
internal class WithMessageBasicExample
7+
internal class WithMessageExample
88
{
99
public void Run()
1010
{
1111
var input = 11;
1212

13-
// begin-snippet: WithMessageBasicExample
13+
// begin-snippet: WithMessageExample
1414
RuleFor(input)
1515
.Equal(8).WithMessage("The two numbers are not equal.")
1616
.Result();

‎README.md‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -54,56 +54,56 @@ There are several built-in validators available out-of-the-box. You can also pro
5454

5555
Ensures the value is not `null` for reference types or a default value for value types. For strings, ensures it is not `null`, an empty string, or only whitespace.
5656

57-
<!-- snippet: NotEmptyBasicExample -->
58-
<a id='snippet-NotEmptyBasicExample'></a>
57+
<!-- snippet: NotEmptyExample -->
58+
<a id='snippet-NotEmptyExample'></a>
5959
```cs
6060
RuleFor(input)
6161
.NotEmpty()
6262
.Result();
6363
```
64-
<sup><a href='/Examples/NotEmptyBasicExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-NotEmptyBasicExample' title='Start of snippet'>anchor</a></sup>
64+
<sup><a href='/Examples/NotEmptyExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-NotEmptyExample' title='Start of snippet'>anchor</a></sup>
6565
<!-- endSnippet -->
6666

6767
## BetweenInclusive Validator
6868

6969
Ensures a number of any type (`int`, `float`, `double`, etc.) is greater than a minimum and less than a maximum.
7070

71-
<!-- snippet: BetweenInclusiveBasicExample -->
72-
<a id='snippet-BetweenInclusiveBasicExample'></a>
71+
<!-- snippet: BetweenInclusiveExample -->
72+
<a id='snippet-BetweenInclusiveExample'></a>
7373
```cs
7474
RuleFor(input)
7575
.BetweenInclusive(6, 14)
7676
.Result();
7777
```
78-
<sup><a href='/Examples/BetweenInclusiveBasicExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-BetweenInclusiveBasicExample' title='Start of snippet'>anchor</a></sup>
78+
<sup><a href='/Examples/BetweenInclusiveExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-BetweenInclusiveExample' title='Start of snippet'>anchor</a></sup>
7979
<!-- endSnippet -->
8080

8181
## BetweenExclusive Validator
8282

8383
Ensures a number of any type (`int`, `float`, `double`, etc.) is greater than or equal to a minimum and less than or equal to a maximum.
8484

85-
<!-- snippet: BetweenExclusiveBasicExample -->
86-
<a id='snippet-BetweenExclusiveBasicExample'></a>
85+
<!-- snippet: BetweenExclusiveExample -->
86+
<a id='snippet-BetweenExclusiveExample'></a>
8787
```cs
8888
RuleFor(input)
8989
.BetweenExclusive(6, 14)
9090
.Result();
9191
```
92-
<sup><a href='/Examples/BetweenExclusiveBasicExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-BetweenExclusiveBasicExample' title='Start of snippet'>anchor</a></sup>
92+
<sup><a href='/Examples/BetweenExclusiveExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-BetweenExclusiveExample' title='Start of snippet'>anchor</a></sup>
9393
<!-- endSnippet -->
9494

9595
## Equal Validator
9696

9797
Ensures the input is considered equal to the provided value. For reference types it checks if the two references are to the same instance (reference equality). For value types, it checks it the types and values are the same (value equality).
9898

99-
<!-- snippet: EqualBasicExample -->
100-
<a id='snippet-EqualBasicExample'></a>
99+
<!-- snippet: EqualExample -->
100+
<a id='snippet-EqualExample'></a>
101101
```cs
102102
RuleFor(input)
103103
.Equal(8)
104104
.Result();
105105
```
106-
<sup><a href='/Examples/EqualBasicExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-EqualBasicExample' title='Start of snippet'>anchor</a></sup>
106+
<sup><a href='/Examples/EqualExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-EqualExample' title='Start of snippet'>anchor</a></sup>
107107
<!-- endSnippet -->
108108

109109
## MinimumLength Validator
@@ -124,42 +124,42 @@ RuleFor(input)
124124

125125
Aka `Matches`, ensure the string passes a regular expression test.
126126

127-
<!-- snippet: MatchesBasicExample -->
128-
<a id='snippet-MatchesBasicExample'></a>
127+
<!-- snippet: MatchesExample -->
128+
<a id='snippet-MatchesExample'></a>
129129
```cs
130130
RuleFor(input)
131131
.Matches("cat")
132132
.Result();
133133
```
134-
<sup><a href='/Examples/MatchesExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-MatchesBasicExample' title='Start of snippet'>anchor</a></sup>
134+
<sup><a href='/Examples/MatchesExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-MatchesExample' title='Start of snippet'>anchor</a></sup>
135135
<!-- endSnippet -->
136136

137137
## Predicate Validator
138138

139139
The predicate (aka `Must`) validator allows you to provide your own validation logic by providing a delegate.
140140

141-
<!-- snippet: MustBasicExample -->
142-
<a id='snippet-MustBasicExample'></a>
141+
<!-- snippet: MustExample -->
142+
<a id='snippet-MustExample'></a>
143143
```cs
144144
RuleFor(input)
145145
.Must(input => input == 7)
146146
.Result();
147147
```
148-
<sup><a href='/Examples/MustBasicExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-MustBasicExample' title='Start of snippet'>anchor</a></sup>
148+
<sup><a href='/Examples/MustExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-MustExample' title='Start of snippet'>anchor</a></sup>
149149
<!-- endSnippet -->
150150

151151
## IsGuid Validator
152152

153153
Ensures the string can be parsed into a valid GUID.
154154

155-
<!-- snippet: IsGuidBasicExample -->
156-
<a id='snippet-IsGuidBasicExample'></a>
155+
<!-- snippet: IsGuidExample -->
156+
<a id='snippet-IsGuidExample'></a>
157157
```cs
158158
RuleFor(input)
159159
.IsGuid()
160160
.Result();
161161
```
162-
<sup><a href='/Examples/IsGuidBasicExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-IsGuidBasicExample' title='Start of snippet'>anchor</a></sup>
162+
<sup><a href='/Examples/IsGuidExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-IsGuidExample' title='Start of snippet'>anchor</a></sup>
163163
<!-- endSnippet -->
164164

165165
# Customizing
@@ -168,14 +168,14 @@ RuleFor(input)
168168

169169
The `WithMessage` method can be used to change the validation error message for a validator.
170170

171-
<!-- snippet: WithMessageBasicExample -->
172-
<a id='snippet-WithMessageBasicExample'></a>
171+
<!-- snippet: WithMessageExample -->
172+
<a id='snippet-WithMessageExample'></a>
173173
```cs
174174
RuleFor(input)
175175
.Equal(8).WithMessage("The two numbers are not equal.")
176176
.Result();
177177
```
178-
<sup><a href='/Examples/WithMessageBasicExample.cs#L13-L17' title='Snippet source file'>snippet source</a> | <a href='#snippet-WithMessageBasicExample' title='Start of snippet'>anchor</a></sup>
178+
<sup><a href='/Examples/WithMessageExample.cs#L13-L17' title='Snippet source file'>snippet source</a> | <a href='#snippet-WithMessageExample' title='Start of snippet'>anchor</a></sup>
179179
<!-- endSnippet -->
180180

181181
# Integrations

0 commit comments

Comments
 (0)