From: Timotheus Pokorra <timotheus.pokorra@solidcharity.com>
Date: Thu, 1 Jun 2023 15:16:31 +0000 (+0200)
Subject: fix comments on function getNotePrivacyHidden
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=8526193b3302b9a44764dd9bc48ca9e23b14c6bc;p=civicrm-core.git

fix comments on function getNotePrivacyHidden

the comments are the wrong way around. this is not about if notes should
be displayed, but if they should be hidden.

related to https://lab.civicrm.org/dev/core/-/issues/4329
---

diff --git a/CRM/Core/BAO/Note.php b/CRM/Core/BAO/Note.php
index 02be74e66a..6595969b94 100644
--- a/CRM/Core/BAO/Note.php
+++ b/CRM/Core/BAO/Note.php
@@ -43,13 +43,13 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note implements \Civi\Core\HookInte
   }
 
   /**
-   * Given a note id, decide if the note should be displayed based on privacy setting
+   * Given a note id, decide if the note should be hidden based on privacy setting
    *
    * @param object $note
    *   Either the id of the note to retrieve, or the CRM_Core_DAO_Note object itself.
    *
    * @return bool
-   *   TRUE if the note should be displayed, otherwise FALSE
+   *   TRUE if the note should be hidden, otherwise FALSE
    *
    */
   public static function getNotePrivacyHidden($note) {