fix: sources/base.py documentation to properly reflect allowed write_strategy arguments

[Danny Xie (dnxie12)]

This PR fixes Source.read()'s documentation to correctly specify the allowed arguments for its write_strategy parameter (merge instead of upsert which is not a valid WriteStragegy enum value)

Summary by CodeRabbit

• Documentation
  • Updated documentation for the read method to clarify valid write_strategy options
  • Replaced "upsert" with "merge" in parameter descriptions and strategy enumeration

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces a documentation update for the read method in the Source class within the airbyte/sources/base.py file. The change specifically modifies the description of the write_strategy parameter, replacing "upsert" with "merge" in both the method documentation and the WriteStrategy enumeration. This update ensures the documentation accurately reflects the current implementation without altering the method's underlying functionality.

Changes

File	Change Summary
airbyte/sources/base.py	Updated method documentation for read() method, changing write_strategy valid options from "upsert" to "merge"

The change appears to be a documentation refinement, synchronizing the method's description with its actual implementation. The valid write strategy options are now explicitly listed as "append", "merge", "replace", or "auto".

Would you like me to elaborate on any aspect of this change? Wdyt? 🤔

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f7b88eb and 0040de7.

📒 Files selected for processing (1)

• airbyte/sources/base.py (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Pytest (No Creds)

🔇 Additional comments (1)

airbyte/sources/base.py (1)

621-622: LGTM! Documentation update looks accurate.

The docstring now correctly reflects the valid options for the write_strategy parameter, replacing "upsert" with "merge" to match the actual WriteStrategy enumeration values. This improves clarity for users of the library.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• 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 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 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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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. (Beta)
• @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 or @coderabbitai title 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.

[Aaron ("AJ") Steers (aaronsteers)]

/test-pr

PR test job started... Check job output.

❌ Tests failed.