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.

Sign up for GitHub

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

chore: fix typos and link update #2453

Merged
merged 1 commit into from
May 5, 2024
Merged

chore: fix typos and link update #2453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion slither/tools/documentation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# slither-documentation

`slither-documentation` uses [codex](https://beta.openai.com) to generate natspec documenation.
`slither-documentation` uses [codex](https://platform.openai.com) to generate natspec documenation.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capitalize the first letter of the sentence for consistency and professionalism.

- `slither-documentation` uses [codex](https://platform.openai.com) to generate natspec documenation.
+ `Slither-documentation` uses [codex](https://platform.openai.com) to generate natspec documentation.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
`slither-documentation` uses [codex](https://platform.openai.com) to generate natspec documenation.
`Slither-documentation` uses [codex](https://platform.openai.com) to generate natspec documentation.

Correct the spelling of "documentation."

- `slither-documentation` uses [codex](https://platform.openai.com) to generate natspec documenation.
+ `slither-documentation` uses [codex](https://platform.openai.com) to generate natspec documentation.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
`slither-documentation` uses [codex](https://platform.openai.com) to generate natspec documenation.
`slither-documentation` uses [codex](https://platform.openai.com) to generate natspec documentation.


This tool is experimental. See [solmate documentation](https://github.com/montyly/solmate/pull/1) for an example of usage.
4 changes: 2 additions & 2 deletions slither/visitors/expression/read_var.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ def result(self) -> List[Expression]:
self._result = list(set(get(self.expression)))
return self._result

# overide assignement
# dont explore if its direct assignement (we explore if its +=, -=, ...)
# override assignment
# dont explore if its direct assignment (we explore if its +=, -=, ...)
def _visit_assignement_operation(self, expression: AssignmentOperation) -> None:
if expression.type != AssignmentOperationType.ASSIGN:
self._visit_expression(expression.expression_left)
Expand Down
2 changes: 1 addition & 1 deletion slither/visitors/slithir/expression_to_slithir.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ def _post_assignement_operation(self, expression: AssignmentOperation) -> None:
right = get(expression.expression_right)
operation: Operation
if isinstance(left, list): # tuple expression:
if isinstance(right, list): # unbox assigment
if isinstance(right, list): # unbox assignment
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change the comment to correct the typo from "assignement" to "assignment."

-    def _post_assignement_operation(self, expression: AssignmentOperation) -> None:
+    def _post_assignment_operation(self, expression: AssignmentOperation) -> None:
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
if isinstance(right, list): # unbox assignment
if isinstance(right, list): # unbox assignment

assert len(left) == len(right)
for idx, _ in enumerate(left):
if (
Expand Down
2 changes: 1 addition & 1 deletion slither/vyper_parsing/declarations/contract.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ def _parse_contract_items(self) -> None:
self._structuresNotParsed.append(node)
elif isinstance(node, ImportFrom):
# TOOD aliases
# We create an `InterfaceDef` sense the compilatuion unit does not contain the actual interface
# We create an `InterfaceDef` sense the compilation unit does not contain the actual interface
# https://github.com/vyperlang/vyper/tree/master/vyper/builtins/interfaces
if node.module == "vyper.interfaces":
interfaces = {
Expand Down
Loading