crytic/slither

Fix typos in detectors documentation

Open

#1,206 opened on May 11, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (4,769 stars) (886 forks)batch import
good first issuehelp wanted

Description

https://github.com/CarstenNZ/slither-wiki/blob/master/Detector-Documentation.md has a couple of fixes / typos in the detectors description.

We should merge them before the next release

Related https://github.com/crytic/slither/issues/1189

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
Review the file 'Detector Documentation.md' in the fork at CarstenNZ/slither wiki (https://github.com/CarstenNZ/slither wiki/blob/master/Detector Documentation.md) and the related issue #1189 (https://github.com/crytic/slither/issues/1189) to identify the typos and suggested fixes. Then, submit a pull request to the main slither wiki repository merging the corrections. No additional investigation is needed beyond reading the referenced files.
Fix typos in detectors documentation · crytic/slither#1206 | Good First Issue