Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update installing_esphome.rst #4380

Closed
wants to merge 1 commit into from
Closed

Update installing_esphome.rst #4380

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 26 additions & 7 deletions guides/installing_esphome.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,20 +48,39 @@

Mac
---
Install Homebrew using the followng command. If you have it installed already, skip the next two steps.

There are no tested installation instructions for Mac. ESPHome does support
Mac & will run with no problem.
.. code-block:: console

Contributions are welcome!
$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

The process will likely be similar to Windows. You can install Python from the
official site, and then install ESPHome with ``pip3 install esphome``. You can
then test that things are properly installed with the following:
Run these commands in your terminal to add Homebrew to your PATH:

.. code-block:: console

$ echo >> /Users/ymulgaonkar/.zprofile
$ echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> /Users/[username]/.zprofile
$ eval "$(/opt/homebrew/bin/brew shellenv)"
Comment on lines +61 to +63
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Remove hardcoded username and improve PATH setup instructions

The current instructions contain a hardcoded username and might confuse users. Let's make it more generic and clear.

-    $ echo >> /Users/ymulgaonkar/.zprofile
-    $ echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> /Users/[username]/.zprofile
-    $ eval "$(/opt/homebrew/bin/brew shellenv)"
+    $ echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zprofile
+    $ eval "$(/opt/homebrew/bin/brew shellenv)"
📝 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.

Suggested change
$ echo >> /Users/ymulgaonkar/.zprofile
$ echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> /Users/[username]/.zprofile
$ eval "$(/opt/homebrew/bin/brew shellenv)"
$ echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zprofile
$ eval "$(/opt/homebrew/bin/brew shellenv)"


Ensure you have Homebrew installed by running this command:

.. code-block:: console

$ brew --version
Homebrew 4.4.2

Now install ESPHome with this command:

.. code-block:: console

Check failure on line 74 in guides/installing_esphome.rst

View workflow job for this annotation

GitHub Actions / build 

Directive 'code-block' is not followed by an empty line. Please insert an empty line after guides/installing_esphome.rst:74

$ brew install esphome
Comment on lines +74 to +76
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix RST formatting: Add empty line after code-block directive

The code-block directive must be followed by an empty line for proper RST rendering.

 .. code-block:: console
+
     $ brew install esphome
📝 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.

Suggested change
.. code-block:: console
$ brew install esphome
.. code-block:: console
$ brew install esphome
🧰 Tools
🪛 GitHub Check: build

[failure] 74-74:
Directive 'code-block' is not followed by an empty line. Please insert an empty line after guides/installing_esphome.rst:74


Confirm your installation by running:

.. code-block:: console

$ esphome version
Version: 2021.12.3
Version: 2024.10.1
Comment on lines 82 to +83
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Let me analyze the version numbers in the documentation to verify the consistency concern.

From the search results, I can see the following ESPHome version numbers in the installing_esphome.rst file:

  • Line 47: Version: 2021.12.3
  • Line 83: Version: 2024.10.1
  • Line 129: Version: 2022.11.4

The review comment correctly identified an inconsistency in the version numbers shown across different platform examples in the installation guide. This could indeed be confusing for users.

Version numbers should be consistent across platform examples

The installation guide shows different ESPHome versions for different platforms:

  • Mac: 2024.10.1
  • Linux: 2022.11.4
  • Windows (earlier example): 2021.12.3

This inconsistency should be updated to show the latest version (2024.10.1) across all platform examples to avoid confusion.

🔗 Analysis chain

Verify version consistency across platforms

The documentation shows different ESPHome versions for different platforms:

  • Mac: 2024.10.1
  • Linux: 2022.11.4

This inconsistency might confuse users. Consider using the same version number across all platform examples to avoid confusion.

Also applies to: 83-83

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if there are other version numbers in the documentation
rg -n "[0-9]+\.[0-9]+\.[0-9]+" --type rst

Length of output: 152744


Linux
-----
Expand Down
Loading