Browse Source

fix(userstatus): Fix docs of user status manager

Signed-off-by: Joas Schilling <coding@schilljs.com>
Joas Schilling 1 month ago
parent
commit
02ebbfb4ea
2 changed files with 2 additions and 2 deletions
  1. 1 1
      lib/public/UserStatus/IManager.php
  2. 1 1
      lib/public/UserStatus/IProvider.php

+ 1 - 1
lib/public/UserStatus/IManager.php

@@ -39,7 +39,7 @@ interface IManager {
 	 * Gets the statuses for all users in $users
 	 * Gets the statuses for all users in $users
 	 *
 	 *
 	 * @param string[] $userIds
 	 * @param string[] $userIds
-	 * @return IUserStatus[]
+	 * @return array<string, IUserStatus> array key being the userid, users without a status will not be in the returned array
 	 * @since 20.0.0
 	 * @since 20.0.0
 	 */
 	 */
 	public function getUserStatuses(array $userIds): array;
 	public function getUserStatuses(array $userIds): array;

+ 1 - 1
lib/public/UserStatus/IProvider.php

@@ -35,7 +35,7 @@ interface IProvider {
 	 * Gets the statuses for all users in $users
 	 * Gets the statuses for all users in $users
 	 *
 	 *
 	 * @param string[] $userIds
 	 * @param string[] $userIds
-	 * @return IUserStatus[]
+	 * @return array<string, IUserStatus> array key being the userid, users without a status will not be in the returned array
 	 * @since 20.0.0
 	 * @since 20.0.0
 	 */
 	 */
 	public function getUserStatuses(array $userIds):array;
 	public function getUserStatuses(array $userIds):array;