Remove references to deprecated python versions in alexa documentation #39785
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Hey there @home-assistant/cloud, @ochlocracy, mind taking a look at this feedback as it has been labeled with an integration ( Code owner commandsCode owners of
|
📝 WalkthroughWalkthroughThe documentation for Alexa Custom Skill and Alexa Smart Home Skill integrations has been updated to generalize the instructions for selecting the Python runtime version when creating AWS Lambda functions. Explicit references to specific minor Python versions have been replaced with a generic "Python 3.*" directive. Changes
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (2)
source/_integrations/alexa.intent.markdown(1 hunks)source/_integrations/alexa.smart_home.markdown(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/alexa.smart_home.markdown
160-160: Emphasis style
Expected: underscore; Actual: asterisk
(MD049, emphasis-style)
160-160: Emphasis style
Expected: underscore; Actual: asterisk
(MD049, emphasis-style)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
| @@ -65,7 +65,7 @@ Next you need to create a Lambda function. | |||
| - **US West (Oregon)** region for Japanese and English (AU) skills. | |||
| - Click `Functions` in the left navigation bar, display list of your Lambda functions. | |||
| - Click `Create function`, select `Author from scratch`, then input a `Function name`. | |||
| - Select *Python 3.* as `Runtime` (Python 3.9 was available at this time). | |||
| - Select *Python 3.* as `Runtime`. | |||
There was a problem hiding this comment.
Wildcard renders incorrectly – users will see “Python 3.” instead of the intended version hint
Markdown interprets * as the closing emphasis delimiter, so *Python 3.* is rendered as Python 3. → “Python 3.”.
The resulting dot-with-no‐wildcard is confusing and could mislead users into choosing an outdated runtime.
- Select *Python 3.* as `Runtime`.
+Select `Python 3.x` as the Runtime (choose the latest available Python 3 version).Using back-ticks (code style) or “3.x” avoids Markdown pitfalls and keeps the guidance clear.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Select *Python 3.* as `Runtime`. | |
| Select `Python 3.x` as the Runtime (choose the latest available Python 3 version). |
🤖 Prompt for AI Agents
In source/_integrations/alexa.intent.markdown at line 68, the text "Select
*Python 3.* as `Runtime`." uses asterisks that Markdown interprets as emphasis
delimiters, causing incorrect rendering. To fix this, replace the asterisks with
back-ticks to format "Python 3.x" as code or write it as "Python 3.x" without
asterisks, ensuring the version hint is clear and correctly displayed.
| @@ -157,7 +157,7 @@ Next you need create a Lambda function. | |||
|
|
|||
| - Click `Functions` in the left navigation bar, to display the list of your Lambda functions. | |||
| - Click `Create function`, select `Author from scratch`, then input a `Function name`. | |||
| - Select *Python 3.9*, *Python 3.8* or *Python 3.7* as `Runtime`. | |||
| - Select *Python 3.* as `Runtime`. | |||
There was a problem hiding this comment.
Same Markdown pitfall here – “Python 3.*” shows up as “Python 3.”
As in the Custom Skill doc, the wildcard star is swallowed by emphasis syntax, leaving an ambiguous “Python 3.” on the rendered page.
- Select *Python 3.* as `Runtime`.
+Select `Python 3.x` as the Runtime (pick the latest Python 3 runtime offered by AWS).This small tweak prevents reader confusion and aligns with AWS’ runtime naming.
Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
160-160: Emphasis style
Expected: underscore; Actual: asterisk
(MD049, emphasis-style)
160-160: Emphasis style
Expected: underscore; Actual: asterisk
(MD049, emphasis-style)
🤖 Prompt for AI Agents
In source/_integrations/alexa.smart_home.markdown at line 160, the text "Python
3.*" is rendered incorrectly as "Python 3." because the asterisk is interpreted
as emphasis in Markdown. To fix this, escape the asterisk or format the text to
prevent Markdown from treating the star as emphasis, ensuring the runtime name
displays correctly as "Python 3.*".
Proposed change
Remove references to deprecated python versions in alexa documentation
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit