-
Notifications
You must be signed in to change notification settings - Fork 56
Fix a typo in attack point iterators documentation #459
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
Conversation
Also make it easier to provide a random value.
Summary of ChangesHello @wsxrdv, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the clarity and accuracy of the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request fixes a typo in the documentation for attack point iterators by correcting the length field in an example. It also makes a minor adjustment to a comment to make it easier to copy-paste code for generating a random value.
The change to length is correct and appreciated. I've added a suggestion to further improve the example for generating a random key to make it syntactically correct and clearer for users.
| "values": [ | ||
| # Single key with hardcoded values: | ||
| [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ] | ||
| # Alternatively we could pick a random key: | ||
| #key = np.random.randint(low=0, high=256, size=16, dtype=np.int64) | ||
| # np.random.randint(low=0, high=256, size=16, dtype=np.int64) | ||
| ] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for improving this example. The current structure of the values list is syntactically incorrect as Python doesn't allow comments to float inside a list literal like this. This can be confusing for users trying to copy-paste the example.
To make the example both syntactically valid and clearer, I suggest restructuring the comments to explain how to switch between a hardcoded key and a randomly generated one.
| "values": [ | |
| # Single key with hardcoded values: | |
| [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ] | |
| # Alternatively we could pick a random key: | |
| #key = np.random.randint(low=0, high=256, size=16, dtype=np.int64) | |
| # np.random.randint(low=0, high=256, size=16, dtype=np.int64) | |
| ] | |
| "values": [ | |
| # Single key with hardcoded values. | |
| # To use a random key, replace the list below with: | |
| # [np.random.randint(low=0, high=256, size=16, dtype=np.int64).tolist()] | |
| [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ] | |
| ] |
Also make it easier to provide a random value.