Skip to content

Commit

Permalink
chore: added aliases and started documenting
Browse files Browse the repository at this point in the history
  • Loading branch information
bmazzarol committed Apr 13, 2024
1 parent 9bb0818 commit 59e57fc
Show file tree
Hide file tree
Showing 46 changed files with 1,246 additions and 416 deletions.
6 changes: 5 additions & 1 deletion Tuxedo.Docs/articles/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,8 @@ this to the top of each `.cs` file that needs it:
using Tuxedo;
```

More to come soon!
If you're using
[implicit usings](https://learn.microsoft.com/en-gb/dotnet/core/project-sdk/overview#implicit-using-directives)
the above is not necessary. This will also import
many useful aliases, and it is recommended to use them over the full
names.
9 changes: 9 additions & 0 deletions Tuxedo.Docs/articles/refinements/numeric/even.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Even

Enforces that a
[signed or unsigned numeric type](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/built-in-types)
is even.

For example,

[!code-csharp[](../../../../Tuxedo.Tests/Numeric/EvenTests.cs#EvenInt)]
9 changes: 9 additions & 0 deletions Tuxedo.Docs/articles/refinements/numeric/negative.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Negative

Enforces that a
[signed or floating point numeric type](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/built-in-types)
is negative.

For example,

[!code-csharp[](../../../../Tuxedo.Tests/Numeric/NegativeTests.cs#NegativeInt)]
9 changes: 9 additions & 0 deletions Tuxedo.Docs/articles/refinements/numeric/positive.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Positive

Enforces that a
[numeric type](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/built-in-types)
is positive.

For example,

[!code-csharp[](../../../../Tuxedo.Tests/Numeric/PositiveTests.cs#PositiveInt)]
7 changes: 7 additions & 0 deletions Tuxedo.Docs/articles/refinements/numeric/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
items:
- name: Positive
href: positive.md
- name: Negative
href: negative.md
- name: Even
href: even.md
3 changes: 3 additions & 0 deletions Tuxedo.Docs/articles/refinements/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
items:
- name: Numeric
href: numeric/toc.yml
2 changes: 2 additions & 0 deletions Tuxedo.Docs/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ items:
href: index.md
- name: Getting Started
href: articles/getting-started.md
- name: Refinements
href: articles/refinements/toc.yml
- name: .NET API Docs
href: api/toc.yml
expanded: true
4 changes: 1 addition & 3 deletions Tuxedo.Tests/GlobalUsings.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,2 @@
// Global using directives

global using FluentAssertions;
global using FluentAssertions;
global using Xunit;
124 changes: 0 additions & 124 deletions Tuxedo.Tests/IntRefinementTests.cs

This file was deleted.

Loading

0 comments on commit 59e57fc

Please sign in to comment.