Skip to content

Commit

Permalink
Merge pull request soutaro#1353 from tk0miya/docs/steep_ignore
Browse files Browse the repository at this point in the history
docs: Add document for steep:ignore comment
  • Loading branch information
soutaro authored Nov 25, 2024
2 parents 8a8a067 + 7f05ee9 commit 14b562e
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions manual/ignore.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Ignore diagnostics

Steep allows you to ignore diagnostics by adding comments to your code.

```ruby
# Ignoring a range of lines

# steep:ignore:start

foo() # NoMethod is detected, but ignored

# steep:ignore:end
```

```ruby
# Ignoring a specific line

foo() # steep:ignore
foo() # steep:ignore NoMethod
```

0 comments on commit 14b562e

Please sign in to comment.