From 562b910aa0957711759ec48acc7cfd53538806de Mon Sep 17 00:00:00 2001 From: Milan Zamazal Date: Wed, 6 Jul 2022 10:20:27 +0200 Subject: [PATCH] Silence checkdoc messages about docstrings of internal objects MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Internal objects here don’t have and shouldn’t have documentation strings because: - There is nothing useful to specify in them. - They are not a stable API to be used. - They would pollute the source file and make it larger. --- pw-access.el | 4 ++++ pw-lib.el | 4 ++++ pw-ui.el | 4 ++++ 3 files changed, 12 insertions(+) diff --git a/pw-access.el b/pw-access.el index 67b1b35..18539a5 100644 --- a/pw-access.el +++ b/pw-access.el @@ -262,4 +262,8 @@ Note this interface may not work with all PipeWire versions.") (provide 'pw-access) +;; Local Variables: +;; checkdoc-force-docstrings-flag: nil +;; End: + ;;; pw-access.el ends here diff --git a/pw-lib.el b/pw-lib.el index 9c42877..d77f2d0 100644 --- a/pw-lib.el +++ b/pw-lib.el @@ -330,4 +330,8 @@ otherwise set the current default sink or source." (provide 'pw-lib) +;; Local Variables: +;; checkdoc-force-docstrings-flag: nil +;; End: + ;;; pw-lib.el ends here diff --git a/pw-ui.el b/pw-ui.el index 1cb46eb..4963101 100644 --- a/pw-ui.el +++ b/pw-ui.el @@ -431,4 +431,8 @@ applied on some of them or the buffer: (provide 'pw-ui) +;; Local Variables: +;; checkdoc-force-docstrings-flag: nil +;; End: + ;;; pw-ui.el ends here