NeuraLegion / sectester-js

SecTester is a new tool that integrates our enterprise-grade scan engine directly into your unit tests.
MIT License
5 stars 4 forks source link

Docs improvements #71

Closed dcheremnov closed 2 years ago

dcheremnov commented 2 years ago

Scan package:

Repeater:

Core:

Bus:

derevnjuk commented 2 years ago

@pmstss please don't close this one, it will be updated step by step

derevnjuk commented 2 years ago

Change const name or switch to var in the second example

It doesn't make any sense, it is totally different code examples referees to different contexts.

Add required cluster property to example

This particular example shows the ability to use particular settings. I don't see any reason to specify all required params which just complicates understanding. BTW we can just use a comment (// ...) to show there might be other params here.

Missing the IssueDetected definition or link to the Core example

The example is intended to show bind usage, everything else is out of scope

dcheremnov commented 2 years ago

BTW we can just use a comment (// ...) to show there might be other params here.

Looks like a solution.