Skip to content

Update Outdated README.md Library Example#1536

Merged
dogancanbakir merged 1 commit intoprojectdiscovery:devfrom
redStarP2:patch-1
Jul 24, 2025
Merged

Update Outdated README.md Library Example#1536
dogancanbakir merged 1 commit intoprojectdiscovery:devfrom
redStarP2:patch-1

Conversation

@redStarP2
Copy link
Copy Markdown
Contributor

@redStarP2 redStarP2 commented Jul 24, 2025 •
edited by coderabbitai bot
Loading

Fix outdated example lib usage

Summary by CodeRabbit

  • Chores
    • Updated internal handling to support context-aware execution for enumeration processes.

@redStarP2
Update README.md
454e840 
Fix outdated example lib usage
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jul 24, 2025 •
edited
Loading

Walkthrough

The update modifies the invocation of the RunEnumeration() method on the naabuRunner instance to include a context.Context parameter (context.Background()). This reflects a change in the method's signature, which now requires a context for context-aware execution.

Changes

File(s) Change Summary
README.md Updated example/code to import context and pass context.Background() to RunEnumeration().

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A context now joins the race,
In code, it finds its place.
Enumeration runs with care,
Context travels everywhere!
A hop, a skip, a bounding leap—
This change is simple, clean, and neat! 🐇

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

coderabbitai[bot]
coderabbitai bot reviewed Jul 24, 2025
View reviewed changes
Copy link
Copy Markdown

@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

🧹 Nitpick comments (1)
README.md (1)

374-381: Group the standard-library imports together

context is part of the Go standard library, but it has been placed in a separate import group after a blank line. While this is only an example in documentation, keeping std-lib imports contiguous (e.g., log, context) followed by a blank line and then third-party imports is the conventional Go style and avoids lint warnings in copy-pasted code.

 import (
-	"log"
-
-	"context"
+	"log"
+	"context"
 
 	"github.com/projectdiscovery/goflags"
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 22c2052 and 454e840.

📒 Files selected for processing (1)
  • README.md (2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md

377-377: Hard tabs
Column: 1

(MD010, no-hard-tabs)

399-399: Hard tabs
Column: 1

(MD010, no-hard-tabs)

🔇 Additional comments (1)
README.md (1)

399-399: Good catch updating the call to the new context-aware API

The example now correctly passes a context.Context to RunEnumeration, reflecting the updated signature. Looks correct as-is. 👍

dogancanbakir
dogancanbakir approved these changes Jul 24, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@dogancanbakir dogancanbakir left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

@dogancanbakir dogancanbakir merged commit a8a872e into projectdiscovery:dev Jul 24, 2025
1 check passed
@BrewTestBot BrewTestBot mentioned this pull request Nov 14, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@dogancanbakir dogancanbakir dogancanbakir approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@redStarP2 @dogancanbakir