[climate] Document public accessor methods for custom modes in 2025.11.0 release

[bdraco]

Description:

This PR adds missing documentation for the Climate entity's public accessor methods (has_custom_fan_mode(), get_custom_fan_mode(), has_custom_preset(), get_custom_preset()) that were introduced in PR #11621.

Changes Made:

1. Release Notes (2025.11.0.md) - YAML Lambda Changes Section

   • Added Climate to the user-facing breaking changes with before/after migration examples
   • Shows migration from custom_fan_mode.has_value()/custom_fan_mode.value() to the new accessor methods

2. Release Notes - Breaking Changes for Developers Section

   • Updated the Climate member access bullet point to mention the public accessor methods alongside the protected setters

3. Climate Entity Documentation (content/components/climate/_index.md)

   • Removed deprecated direct member access examples for custom_fan_mode and custom_preset from the attributes list
   • Added new "Custom mode accessor methods" section documenting all four public accessor methods
   • Added prominent warning about nullptr safety when using the getter methods without checking first

Technical Details:

The changes document the API transition from:

• Old: optional<std::string> custom_fan_mode (public member, direct access)
• New: const char* custom_fan_mode_ (private member, accessor methods)

Related issue (if applicable): N/A

Pull request in esphome with YAML changes (if applicable):

• PR#11621 (not linked because the bot kept complaining)

Checklist:

• I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

• Link added in /components/index.rst when creating new documents for new components or cookbook. (N/A - updating existing documentation)

[esphome]

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

[esphome]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

[coderabbitai]

Walkthrough

Documentation and API docs updated for the Climate component: the public string properties custom_fan_mode and custom_preset were removed from the read-only attributes and replaced by four accessors — has_custom_fan_mode(), get_custom_fan_mode(), has_custom_preset(), and get_custom_preset() — with docs and changelog updated to match.

Changes

Cohort / File(s)	Change Summary
Changelog content/changelog/2025.11.0.md	Added entry documenting addition of four public accessor methods for custom modes and deprecation of direct access to custom_fan_mode_ / custom_preset_; updated breaking-changes guidance to instruct using has_* / get_*.
Climate component docs content/components/climate/_index.md	Removed public string accessors custom_fan_mode and custom_preset; added documentation for has_custom_fan_mode(), get_custom_fan_mode(), has_custom_preset(), get_custom_preset() including usage notes and nullptr warning; updated API signatures shown in docs.

Sequence Diagram(s)

(This change is documentation/API signature-only; no control-flow diagram applicable.)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• Verify documentation accurately reflects exact method signatures and return types.
• Confirm removal of public string accessors is reflected everywhere in the docs and changelog.
• Check the nullptr warning and usage examples for correctness and clarity.

Suggested reviewers

• kbx81

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: documenting new public accessor methods for Climate custom modes in the 2025.11.0 release.
Description check	✅ Passed	The description provides detailed context about the PR, explaining the purpose (documenting accessor methods), the specific changes made (release notes updates and documentation additions), and technical details about the API transition.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch climate_getters

---

📜 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 cbfcd4e and 2124dee.

📒 Files selected for processing (1)

• content/changelog/2025.11.0.md (2 hunks)

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

• content/changelog/2025.11.0.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

• Provide your own instructions using the high_level_summary_instructions setting.
• Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
• Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
4. 📊 Contributor Summary — Include a Markdown table showing contributions:
   | Contributor | Lines Added | Lines Removed | Files Changed |
5. ✔️ Additional Notes — Add any extra reviewer context.
   Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[esphome]

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

[netlify]

✅ Deploy Preview for esphome ready!

Name	Link
🔨 Latest commit	2124dee
🔍 Latest deploy log	https://app.netlify.com/projects/esphome/deploys/691f7ca76e10050008f83484
😎 Deploy Preview	https://deploy-preview-5653--esphome.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[Copilot]

Pull Request Overview

Documents public accessor methods for Climate entity custom modes introduced in ESPHome 2025.11.0, replacing direct member access patterns.

• Added migration guide in release notes showing transition from optional member access to accessor methods
• Updated Climate component documentation to show new accessor methods (has_custom_fan_mode(), get_custom_fan_mode(), has_custom_preset(), get_custom_preset())
• Added nullptr safety warning with correct/incorrect usage examples

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
content/changelog/2025.11.0.md	Added YAML lambda migration examples and updated developer breaking changes to document accessor methods
content/components/climate/_index.md	Removed deprecated direct member access examples and added new accessor methods section with nullptr safety warning

Stale

[esphome]

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

its already released