Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document use of beam_files #541

Closed
paulo-ferraz-oliveira opened this issue Oct 6, 2020 · 1 comment
Closed

Document use of beam_files #541

paulo-ferraz-oliveira opened this issue Oct 6, 2020 · 1 comment
Labels
documentation Documentation

Comments

@paulo-ferraz-oliveira
Copy link
Collaborator

paulo-ferraz-oliveira commented Oct 6, 2020

We should add a generic section stating some analysis types work over .beam files and then, per rule, have a "Works on .beam?" reference.

e.g.

beam_files

Certain rules (signaled with "Works on .beam file? Yes!") allow you to perform analysis directly on beam files (instead of source code).

Though this analysis may be useful for pin-pointing certain elements, beware that, e.g., reported line_numbers will most surely not corresponding to those in the source file.

@paulo-ferraz-oliveira
Copy link
Collaborator Author

This has been added to the Rules wiki.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation
Projects
None yet
Development

No branches or pull requests

1 participant