[clang-tools-extra] [clang-tidy] Mention std::forward_list in container-size-empty doc (PR #120701)
Niels Dekker via cfe-commits
cfe-commits at lists.llvm.org
Fri Dec 20 01:33:15 PST 2024
https://github.com/N-Dekker created https://github.com/llvm/llvm-project/pull/120701
Mentioned `std::forward_list` as example of a container without `size()`.
>From e58124c491f46238538bb06f14de31f4d5f25d2a Mon Sep 17 00:00:00 2001
From: Niels Dekker <N.Dekker at lumc.nl>
Date: Fri, 20 Dec 2024 10:30:54 +0100
Subject: [PATCH] [clang-tidy] Mention std::forward_list in
container-size-empty doc
Mentioned `std::forward_list` as example of a container without `size()`.
---
.../clang-tidy/readability/ContainerSizeEmptyCheck.h | 8 ++++----
.../checks/readability/container-size-empty.rst | 7 ++++---
2 files changed, 8 insertions(+), 7 deletions(-)
diff --git a/clang-tools-extra/clang-tidy/readability/ContainerSizeEmptyCheck.h b/clang-tools-extra/clang-tidy/readability/ContainerSizeEmptyCheck.h
index 3aa4bdc496194b..e449686f77566d 100644
--- a/clang-tools-extra/clang-tidy/readability/ContainerSizeEmptyCheck.h
+++ b/clang-tools-extra/clang-tidy/readability/ContainerSizeEmptyCheck.h
@@ -19,10 +19,10 @@ namespace clang::tidy::readability {
///
/// The emptiness of a container should be checked using the `empty()` method
/// instead of the `size()`/`length()` method. It shows clearer intent to use
-/// `empty()`. Furthermore some containers may implement the `empty()` method
-/// but not implement the `size()` or `length()` method. Using `empty()`
-/// whenever possible makes it easier to switch to another container in the
-/// future.
+/// `empty()`. Furthermore some containers (for example, a `std::forward_list`)
+/// may implement the `empty()` method but not implement the `size()` or
+/// `length()` method. Using `empty()` whenever possible makes it easier to
+/// switch to another container in the future.
class ContainerSizeEmptyCheck : public ClangTidyCheck {
public:
ContainerSizeEmptyCheck(StringRef Name, ClangTidyContext *Context);
diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability/container-size-empty.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/container-size-empty.rst
index 6a007f69767abe..43ad74f60dbe57 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/readability/container-size-empty.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/readability/container-size-empty.rst
@@ -9,9 +9,10 @@ with a call to ``empty()``.
The emptiness of a container should be checked using the ``empty()`` method
instead of the ``size()``/``length()`` method. It shows clearer intent to use
-``empty()``. Furthermore some containers may implement the ``empty()`` method
-but not implement the ``size()`` or ``length()`` method. Using ``empty()``
-whenever possible makes it easier to switch to another container in the future.
+``empty()``. Furthermore some containers (for example, a ``std::forward_list``)
+may implement the ``empty()`` method but not implement the ``size()`` or
+``length()`` method. Using ``empty()`` whenever possible makes it easier to
+switch to another container in the future.
The check issues warning if a container has ``empty()`` and ``size()`` or
``length()`` methods matching following signatures:
More information about the cfe-commits
mailing list