Revert "Adjust async_step_reconfigure documentation (#2345)"

[epenet]

This reverts commit b86ac6c3f10d1786cb759c61bd2ae22f0b708226.

Proposed change

Type of change

• [ ] Document existing features within Home Assistant
• [x] Document new or changing features which there is an existing pull request elsewhere
• [ ] Spelling or grammatical corrections, or rewording for improved clarity
• [ ] Changes to the backend of this documentation
• [ ] Removed stale or deprecated documentation

Additional information

• This PR fixes or closes issue: fixes #
• Link to relevant existing code or pull request: https://github.com/home-assistant/core/pull/127329

Summary by CodeRabbit

• Documentation
  • Enhanced clarity and structure of the configuration flow for integrations.
  • Introduced a section on reconfiguration, allowing modification of existing config entries.
  • Clarified reauthentication processes with examples for managing authentication errors.
  • Emphasized the importance of testing config flows with mandated full test coverage.

[coderabbitai[bot]]

📝 Walkthrough

## Walkthrough The documentation for `docs/config_entries_config_flow_handler.md` has been significantly revised to improve the clarity and functionality of configuration flows for integrations. Key updates include a structured approach to defining configuration flows, the introduction of a `Config Flow Handler`, and detailed explanations on managing unique IDs and reconfiguration. Additionally, new methods have been added to the `OAuth2FlowHandler` class in `config_flow.py` to facilitate reauthentication and entry creation. These changes aim to provide clearer guidance for developers on implementing and testing config flows. ## Changes | File | Change Summary | |--------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | docs/config_entries_config_flow_handler.md | Enhanced documentation on configuration flows, including structured definitions, reconfiguration processes, reauthentication handling, and testing requirements. | | config_flow.py | - Updated method signature for `async_step_reconfigure` in `ExampleConfigFlow`.
- Added methods: `async_step_reauth`, `async_step_reauth_confirm`, and `async_oauth_create_entry` in `OAuth2FlowHandler`. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant ConfigFlowHandler participant OAuth2FlowHandler User->>ConfigFlowHandler: Initiate config flow ConfigFlowHandler->>User: Request configuration data User->>ConfigFlowHandler: Provide configuration data ConfigFlowHandler->>ConfigFlowHandler: Validate data ConfigFlowHandler->>User: Confirm configuration entry User->>OAuth2FlowHandler: Reauthentication request OAuth2FlowHandler->>User: Request reauthentication data User->>OAuth2FlowHandler: Provide reauthentication data OAuth2FlowHandler->>OAuth2FlowHandler: Validate reauthentication OAuth2FlowHandler->>User: Confirm reauthentication ```

---

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `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 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.