From 868728853b15de3906e339d8624bc12199282fee Mon Sep 17 00:00:00 2001 From: Katherine Scott Date: Wed, 18 Dec 2024 15:04:01 -0800 Subject: [PATCH 1/5] Update source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst Co-authored-by: Chris Lalancette Signed-off-by: Katherine Scott --- source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst b/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst index 37ff1c171d..c369d93a2e 100644 --- a/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst +++ b/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst @@ -17,7 +17,7 @@ Background The ``ament`` family of CLI tools are used for CMake-based software development with ROS 2. Ament ships with a collection of CLI programs that can help users write code that meet the ROS 2 coding standards. Using these tools can greatly increase development velocity and help users write ROS applications and core code that meet `the ROS project's coding standards <../../The-ROS2-Project/Contributing/Code-Style-Language-Versions>`. -We recommend that ROS developers familiarize themselves with these tools and use them before submitting their final pull requests. +We recommend that ROS developers familiarize themselves with these tools and use them before submitting their pull requests. Prerequisites ------------- From 34a0ac096381f8b9a36a0fc3408ef3334b0dcd8a Mon Sep 17 00:00:00 2001 From: Katherine Scott Date: Wed, 18 Dec 2024 15:04:13 -0800 Subject: [PATCH 2/5] Update source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst Co-authored-by: Chris Lalancette Signed-off-by: Katherine Scott --- source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst b/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst index c369d93a2e..93e0124679 100644 --- a/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst +++ b/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst @@ -192,8 +192,8 @@ Applying ``ament_cpplint`` to this file will yield the following errors: `Flake8 `_ is a Python tool for linting and style enforcement. The ``ament_flake8`` command line tool can be used to quickly perform linting of Python source code files using `Flake8 `_. -This tool will help you locate and fix minor errors and style problems with your ROS Python programs such as trailing whitespace, overly long lines of code, poorly spaced function arguments, and much more! -Unfortunately, at this time, ``ament_flake8`` is unable to to automatically fix these issues. +This tool will help you locate minor errors and style problems with your ROS Python programs such as trailing whitespace, overly long lines of code, poorly spaced function arguments, and much more! +Note, however, that ``flake8`` and ``ament_flake8`` cannot automatically reformat code to fix these issues. Deveopers who whould like to address linting issues can use `Python's Black utility `_ to fix formatting issues automatically. 4.1 ``ament_flake8`` Arguments From fea32bb8a18e29457c0ed52cd9eeb3918fe18414 Mon Sep 17 00:00:00 2001 From: Katherine Scott Date: Wed, 18 Dec 2024 15:04:23 -0800 Subject: [PATCH 3/5] Update source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst Co-authored-by: Chris Lalancette Signed-off-by: Katherine Scott --- source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst b/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst index 93e0124679..483325e5e4 100644 --- a/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst +++ b/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst @@ -194,7 +194,6 @@ Applying ``ament_cpplint`` to this file will yield the following errors: The ``ament_flake8`` command line tool can be used to quickly perform linting of Python source code files using `Flake8 `_. This tool will help you locate minor errors and style problems with your ROS Python programs such as trailing whitespace, overly long lines of code, poorly spaced function arguments, and much more! Note, however, that ``flake8`` and ``ament_flake8`` cannot automatically reformat code to fix these issues. -Deveopers who whould like to address linting issues can use `Python's Black utility `_ to fix formatting issues automatically. 4.1 ``ament_flake8`` Arguments ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 5a0aa87c1d3b0e12591ebea9accada038b4fafce Mon Sep 17 00:00:00 2001 From: Katherine Scott Date: Wed, 18 Dec 2024 15:04:31 -0800 Subject: [PATCH 4/5] Update source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst Co-authored-by: Chris Lalancette Signed-off-by: Katherine Scott --- source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst b/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst index 483325e5e4..d663f39f17 100644 --- a/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst +++ b/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst @@ -39,7 +39,7 @@ All ament linting tools have the following built-in options. The built-in help messages usually have the most accurate and up-to-date documentation of the tool. * ``--exclude [filename ...]`` - The filenames to exclude from analysis, including wildcards. * ``--xunit-file XUNIT_FILE`` - Generate a `xunit `_ compliant XML file. - These files are most commonly used by IDEs to automate the ingestion of external development tools. + These files are most commonly used by IDEs and CI to automate the ingestion of test results. From ace6d26d6070398b6eebce13bf2eb2f54e4b0805 Mon Sep 17 00:00:00 2001 From: Katherine Scott Date: Wed, 18 Dec 2024 15:04:41 -0800 Subject: [PATCH 5/5] Update source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst Co-authored-by: Chris Lalancette Signed-off-by: Katherine Scott --- source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst b/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst index d663f39f17..b0b9ab5a5b 100644 --- a/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst +++ b/source/Tutorials/Advanced/Ament-Lint-For-Clean-Code.rst @@ -31,7 +31,7 @@ Ament Lint CLI Tools -------------------- All ament linting tools use a similar CLI pattern. -They take in a directory, a list of directories, file, or list of files, analyze the input files, and generate report. +They take in a directory, a list of directories, file, or list of files, analyze the input files, and generate a report. All ament linting tools have the following built-in options. **The most up to date and accurate documentation for a given ament tool can be found by using the tools built in ``--help`` functionality.**