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

Provide an example of propper use for reference #7

Closed
4censord opened this issue Nov 4, 2021 · 1 comment
Closed

Provide an example of propper use for reference #7

4censord opened this issue Nov 4, 2021 · 1 comment

Comments

@4censord
Copy link

4censord commented Nov 4, 2021

It would be interesting to see how a simple, non malicious comment is seen by today's warnings.

I would recomend a having at least

  • a copyright notice
  • and a function comment ala // ask Joe why this works
  • A multi paragraph comment explaining a concept.
@nickboucher
Copy link
Owner

Hi @4censord --

First, thanks for the copyright notice point; I've realized that this repo was missing a license, and I've added an MIT License just now.

For the other points, I completely agree that these examples would be useful and interesting. My goal for this repo is to keep the examples very simple and closely related to what would be found in the related paper. My recommendation would be to make a new repo that contains these examples, and to circle back to this issue with a link so that it can be easily found. If you choose to do this, I'll be interested to see what kind of examples you come up with!

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

No branches or pull requests

2 participants