Mercurial > public > mercurial-scm > hg
changeset 52749:aa948d9e3fee
interfaces: add a class level doc comment to the `IMatcher` class
This is trivial and can probably be expanded, but I wanted *something* to show
how PyCharm propagates the documentation in its tooltips.
| author | Matt Harbison <matt_harbison@yahoo.com> |
|---|---|
| date | Thu, 06 Feb 2025 15:17:37 -0500 |
| parents | fecda9f44e57 |
| children | 2a5450ecde20 |
| files | mercurial/interfaces/matcher.py |
| diffstat | 1 files changed, 3 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/mercurial/interfaces/matcher.py Thu Feb 06 20:03:57 2025 -0500 +++ b/mercurial/interfaces/matcher.py Thu Feb 06 15:17:37 2025 -0500 @@ -23,6 +23,9 @@ class IMatcher(Protocol): + """A protocol class that defines the common interface for all file matching + classes.""" + @abc.abstractmethod def was_tampered_with_nonrec(self) -> bool: ...