Skip to content
This repository has been archived by the owner on Dec 1, 2024. It is now read-only.

Commit

Permalink
Add some comment about the purpose of this test
Browse files Browse the repository at this point in the history
  • Loading branch information
Atry committed Dec 10, 2021
1 parent a4c11c5 commit c32fbc8
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions tests/HHClientDuplicatedLintErrorTest.hack
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,18 @@ namespace Facebook\HHAST;
use type Facebook\HackTest\DataProvider;
use namespace HH\Lib\{C, Str, Vec};

/**
* The test suite ensures that no lint error is found by `HHClientLinter` in
* the examples for `SingleRuleLinter`s.
*
* If an example triggers hh_client lint errors that indicates problems other
* than the `SingleRuleLinter` supposes to detect, add HHAST_IGNORE_ALL markers
* to suppress them. If an example triggers hh_client lint errors that
* indicates problems that are essentially the same as `SingleRuleLinter`
* supposes to detect, it means the `SingleRuleLinter` is a duplicate of the
* hh_client lint error, and we should either disable the hh_client lint error
* code or remove the `SingleRuleLinter`.
*/
final class HHClientDuplicatedLintErrorTest extends TestCase {
use HHClientLinterTestTrait;
const HHClientLinter::TConfig CONFIG = shape();
Expand Down

0 comments on commit c32fbc8

Please sign in to comment.