[clang-tidy] Sync ContainerSizeEmptyCheck with container-size-empty doc

[N-Dekker]

Brought the class documentation in sync with the user documentation at container-size-empty.rst:

llvm-project/clang-tools-extra/docs/clang-tidy/checks/readability/container-size-empty.rst

Lines 7 to 14 in bfb2620

	Checks whether a call to the ``size()``/``length()`` method can be replaced
	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.

[llvmbot]

@llvm/pr-subscribers-clang-tidy

@llvm/pr-subscribers-clang-tools-extra

Author: Niels Dekker (N-Dekker)

Changes

Brought the class documentation in sync with the user documentation at container-size-empty.rst:

llvm-project/clang-tools-extra/docs/clang-tidy/checks/readability/container-size-empty.rst

Lines 7 to 14 in bfb2620

	Checks whether a call to the ``size()``/``length()`` method can be replaced
	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.

---

Full diff: https://github.com/llvm/llvm-project/pull/118459.diff

1 Files Affected:

• (modified) clang-tools-extra/clang-tidy/readability/ContainerSizeEmptyCheck.h (+4-4)

diff --git a/clang-tools-extra/clang-tidy/readability/ContainerSizeEmptyCheck.h b/clang-tools-extra/clang-tidy/readability/ContainerSizeEmptyCheck.h
index acd8a6bfc50f5e..5f189b426f2413 100644
--- a/clang-tools-extra/clang-tidy/readability/ContainerSizeEmptyCheck.h
+++ b/clang-tools-extra/clang-tidy/readability/ContainerSizeEmptyCheck.h
@@ -18,10 +18,10 @@ namespace clang::tidy::readability {
 /// a call to `empty()`.
 ///
 /// The emptiness of a container should be checked using the `empty()` method
-/// instead of the `size()` method. It shows clearer intent to use `empty()`.
-/// Furthermore some containers may implement the `empty()` method but not
-/// implement the `size()` method. Using `empty()` whenever possible makes it
-/// easier to switch to another container in the future.
+/// 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.
 class ContainerSizeEmptyCheck : public ClangTidyCheck {
 public:
   ContainerSizeEmptyCheck(StringRef Name, ClangTidyContext *Context);

[github-actions]

✅ With the latest revision this PR passed the C/C++ code formatter.

[N-Dekker]

Thank you both for your approval, @HerrCai0907 and @carlosgalvezp. I'm considering to propose mentioning std::forward_list here, as it is the one STL container that does not implement size(). But maybe first wait for this one (#118459) to get merged...

[N-Dekker]

@HerrCai0907 Thanks again for your approval, and for merging my very first LLVM PR (#117629). Can you please 🙏 merge this one as well?