Skip to content

Update code formatting article after wpiformat update #2268

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

Merged
merged 2 commits into from
Jun 12, 2023
Merged

Update code formatting article after wpiformat update #2268

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d512e5
Update code formatting article after wpiformat update
rzblue Jun 2, 2023
bd4392a
update RLI
rzblue Jun 8, 2023
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
7 changes: 2 additions & 5 deletions source/docs/software/advanced-gradlerio/code-formatting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,9 +176,6 @@ Requirements
^^^^^^^^^^^^

- `Python 3.6 or higher <https://www.python.org/>`__
- clang-format (included with `LLVM <https://releases.llvm.org/download.html>`__)

.. important:: Windows is not currently supported at this time! Installing LLVM with Clang **will** break normal robot builds if installed on Windows.

You can install `wpiformat <https://github.com/wpilibsuite/styleguide/blob/main/wpiformat/README.rst>`__ by typing ``pip3 install wpiformat`` into a terminal or command prompt.

Expand Down Expand Up @@ -213,6 +210,6 @@ An example styleguide is shown below:

You can turn this into a :doc:`CI check <robot-code-ci>` by running ``git --no-pager diff --exit-code HEAD``, as shown in the example GitHub Actions workflow below:

.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2023.4.3/.github/workflows/lint-format.yml
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/5fac18ff4ad1db92ec6fcbd437043a38028e99c4/.github/workflows/lint-format.yml
:language: yaml
:lines: 1-5, 12-40
:lines: 1-5, 12-34