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

chore: fix some typos in comments #2433

Merged
merged 2 commits into from
Apr 18, 2024
Merged

chore: fix some typos in comments #2433

merged 2 commits into from
Apr 18, 2024

Conversation

careworry
Copy link
Contributor

@careworry careworry commented Apr 18, 2024

Summary by CodeRabbit

  • Documentation
    • Corrected multiple typos in comments across various files to enhance clarity and consistency in the documentation.

@CLAassistant
Copy link

CLAassistant commented Apr 18, 2024

CLA assistant check
All committers have signed the CLA.

Copy link

coderabbitai bot commented Apr 18, 2024

Walkthrough

The recent updates across various modules of the Slither project primarily focus on correcting typographical errors in comments. These corrections enhance the clarity and professionalism of the documentation without affecting the underlying functionality of the code.

Changes

Files Change Summary
.../function.py, .../convert.py, .../analysis.py Corrected typo "dupplicate" to "duplicate" in comments.
.../naming_convention.py Fixed typo "beggining" to "beginning" in a comment.
.../divide_before_multiply.py Typos in comments corrected for clarity.
.../test_ssa_generation.py Corrected "a a" to "a" in documentation.

🐇✨
A little rabbit hopped through the code,
Fixing letters that in rows oddly strode.
From "dupplicate" to "duplicate" it leaped,
Ensuring clarity in comments was reaped.
With each hop, the docs grew more defined,
A trail of polished words it left behind. 🌟


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between fdf54f6 and bb8ad18.
Files selected for processing (6)
  • slither/core/declarations/function.py (4 hunks)
  • slither/detectors/naming_convention/naming_convention.py (1 hunks)
  • slither/detectors/statements/divide_before_multiply.py (2 hunks)
  • slither/slithir/convert.py (1 hunks)
  • slither/tools/kspec_coverage/analysis.py (1 hunks)
  • tests/unit/slithir/test_ssa_generation.py (1 hunks)
Files skipped from review due to trivial changes (4)
  • slither/detectors/naming_convention/naming_convention.py
  • slither/detectors/statements/divide_before_multiply.py
  • slither/tools/kspec_coverage/analysis.py
  • tests/unit/slithir/test_ssa_generation.py
Additional Context Used
Ruff (4)
slither/core/declarations/function.py (1)

625-625: Test for membership should be not in

slither/slithir/convert.py (3)

354-354: Test for membership should be not in


1893-1893: Test for membership should be not in


1903-1903: Test for membership should be not in

Additional comments not posted (5)
slither/core/declarations/function.py (4)

1596-1596: Corrected typo in comment enhances clarity.


1607-1607: Corrected typo in comment enhances clarity.


1617-1617: Corrected typo in comment enhances clarity.


1627-1627: Corrected typo in comment enhances clarity.

slither/slithir/convert.py (1)

485-485: Corrected typo in comment from "dupplicate" to "duplicate" enhances clarity.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Actionable comments outside the diff hunks (3)
slither/slithir/convert.py (3)

Line range hint 354-354: Use not in for membership testing to improve readability and align with Python best practices.

- if ins.lvalue.name in to_keep and ins != last_elem:
+ if ins.lvalue.name not in to_keep and ins != last_elem:

Line range hint 1893-1893: Use not in for membership testing to improve readability and align with Python best practices.

- if ir.lvalue.name in to_keep:
+ if ir.lvalue.name not in to_keep:

Line range hint 1903-1903: Use not in for membership testing to improve readability and align with Python best practices.

- if ir.lvalue.name in to_keep:
+ if ir.lvalue.name not in to_keep:

@0xalpharush 0xalpharush changed the base branch from master to dev April 18, 2024 12:30
@0xalpharush 0xalpharush merged commit ec06304 into crytic:dev Apr 18, 2024
74 checks passed
@0xalpharush
Copy link
Contributor

Thanks @careworry!

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

Successfully merging this pull request may close these issues.

3 participants