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

Adding warning clause for better understanding #4619

Open
wants to merge 2 commits into
base: current
Choose a base branch
from
Open

Adding warning clause for better understanding #4619

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8339b26
Update i2s_audio.rst
rajarshidcoder Jan 29, 2025
ef4875e
Merge pull request #1 from rajarshidcoder/rajarshidcoder-patch-1
rajarshidcoder Jan 29, 2025
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
4 changes: 3 additions & 1 deletion components/i2s_audio.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
:image: i2s_audio.svg

The ``i2s_audio`` component allows for sending and receiving audio via I²S.
This component only works on ESP32 based chips.

.. warning::

Check failure on line 12 in components/i2s_audio.rst

View workflow job for this annotation

GitHub Actions / build 

Directive 'warning' is not followed by an empty line. Please insert an empty line after components/i2s_audio.rst:12
This component **only** works on ESP32 based chips.
Comment on lines +12 to +13
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 formatting: Add empty line after warning directive.

The warning directive must be followed by an empty line to comply with RST formatting rules.

Apply this diff to fix the formatting:

 .. warning::
+
     This component **only** works on ESP32 based chips.
📝 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
.. warning::
This component **only** works on ESP32 based chips.
.. warning::
This component **only** works on ESP32 based chips.
🧰 Tools
🪛 GitHub Check: build

[failure] 12-12:
Directive 'warning' is not followed by an empty line. Please insert an empty line after components/i2s_audio.rst:12

🪛 GitHub Actions: Lint

[error] 12-12: Directive 'warning' is not followed by an empty line. Please insert an empty line after the directive.


.. code-block:: yaml

Expand Down
Loading