Author: Niels Dekker Date: 2025-01-11T10:15:17+01:00 New Revision: 30bb1863892a235fe1d90eb6b496bd24b0c177d8
URL: https://github.com/llvm/llvm-project/commit/30bb1863892a235fe1d90eb6b496bd24b0c177d8 DIFF: https://github.com/llvm/llvm-project/commit/30bb1863892a235fe1d90eb6b496bd24b0c177d8.diff LOG: [clang-tidy] Mention std::forward_list in container-size-empty doc (#120701) Mentioned `std::forward_list` as example of a container without `size()`. Added: Modified: clang-tools-extra/clang-tidy/readability/ContainerSizeEmptyCheck.h clang-tools-extra/docs/clang-tidy/checks/readability/container-size-empty.rst Removed: ################################################################################ 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: _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
