Fix broken URL

[ian0371]

Fix incorrect-assembly-return in URLs to incorrect-return-in-assembly
https://github.com/crytic/slither/wiki/Detector-Documentation#incorrect-return-in-assembly

Summary by CodeRabbit

• Documentation
  • Updated URLs in the detector descriptions for more accurate guidance on handling incorrect returns in assembly mode.

[CLAassistant]

All committers have signed the CLA.

[coderabbitai]

Warning

Rate Limit Exceeded

@ian0371 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 26 minutes and 26 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between d86d0a2 and 5c52df7.

Walkthrough

The recent update aims to refine the accuracy and relevance of documentation in the slither tool, focusing on assembly code detectors. By rectifying and enhancing URLs in detector descriptions, users are guided to more specific resources for addressing incorrect returns in assembly blocks.

Changes

File Path	Change Summary
README.md	Corrected URLs in detector descriptions related to assembly mode.
slither/detectors/assembly/incorrect_return.py slither/detectors/assembly/return_instead_of_leave.py	Updated URLs in documentation for clearer insight on incorrect return statements in assembly code.

🐰✨
In the realm of code, where bugs like to hide,
A rabbit hopped in, with updates applied.
With URLs corrected, and paths made clear,
"To better coding," it whispered, "we're one hop nearer."
🌟🐾

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between e3dcf1e and 2f02fb4.

Files selected for processing (3)

• README.md (1 hunks)
• slither/detectors/assembly/incorrect_return.py (1 hunks)
• slither/detectors/assembly/return_instead_of_leave.py (1 hunks)

Files skipped from review due to trivial changes (2)

• slither/detectors/assembly/incorrect_return.py
• slither/detectors/assembly/return_instead_of_leave.py

Additional comments: 2

README.md (2)

• 134-134: The URL correction from incorrect-assembly-return to incorrect-return-in-assembly aligns with the PR objectives and ensures users are directed to the correct documentation page.
• 137-137: The URL correction for the return-leave detector documentation also aligns with the PR objectives, ensuring accuracy in documentation references.

[0xalpharush]

I'm not sure I understand the motivation for the changes. Since these are two separate detectors, they should point to different urls. Perhaps the wiki just is out-of-date and we need to update it

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 2f02fb4 and d86d0a2.

Files selected for processing (1)

• slither/detectors/assembly/return_instead_of_leave.py (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• slither/detectors/assembly/return_instead_of_leave.py

[ian0371]

@0xalpharush This PR fixes broken links with the correct wiki URL. I just updated the PR title. They point to different sections now as @elopez suggested.
@elopez You're right, thanks!

[0xalpharush]

Thanks @ian0371 for the PR, but I merged another due to the CI failure. This was replaced by #2299