Skip to content

Commit

Permalink
Generate MultipleTEnumValues documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
egiurleo committed Apr 15, 2024
1 parent 03d0b36 commit f01193b
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
1 change: 1 addition & 0 deletions manual/cops.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ In the following section you find all available cops:
* [Sorbet/IgnoreSigil](cops_sorbet.md#sorbetignoresigil)
* [Sorbet/ImplicitConversionMethod](cops_sorbet.md#sorbetimplicitconversionmethod)
* [Sorbet/KeywordArgumentOrdering](cops_sorbet.md#sorbetkeywordargumentordering)
* [Sorbet/MultipleTEnumValues](cops_sorbet.md#sorbetmultipletenumvalues)
* [Sorbet/ObsoleteStrictMemoization](cops_sorbet.md#sorbetobsoletestrictmemoization)
* [Sorbet/OneAncestorPerLine](cops_sorbet.md#sorbetoneancestorperline)
* [Sorbet/RedundantExtendTSig](cops_sorbet.md#sorbetredundantextendtsig)
Expand Down
27 changes: 27 additions & 0 deletions manual/cops_sorbet.md
Original file line number Diff line number Diff line change
Expand Up @@ -639,6 +639,33 @@ sig { params(b: String, a: Integer).void }
def foo(b:, a: 1); end
```
## Sorbet/MultipleTEnumValues
Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
--- | --- | --- | --- | ---
Enabled | Yes | No | 0.8.2 | -
Disallow creating a `T::Enum` with less than two values.
### Examples
```ruby
# bad
class ErrorMessages < T::Enum
enums do
ServerError = new("There was a server error.")
end
end

# good
class ErrorMessages < T::Enum
enums do
ServerError = new("There was a server error.")
NotFound = new("The resource was not found.")
end
end
```
## Sorbet/ObsoleteStrictMemoization
Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
Expand Down

0 comments on commit f01193b

Please sign in to comment.