From b9bb651787d4c8525eac75963563ff573fd3591b Mon Sep 17 00:00:00 2001
From: owenpearson <owen.pearson@ably.com>
Date: Thu, 14 Mar 2024 13:55:31 +0000
Subject: [PATCH] docs: fix jsdoc lint warnings

---
 .eslintrc.js | 3 +++
 ably.d.ts    | 8 +++-----
 2 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/.eslintrc.js b/.eslintrc.js
index 478a3b8066..6ec70e9243 100644
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -44,6 +44,9 @@ module.exports = {
       extends: [
         'plugin:jsdoc/recommended',
       ],
+      rules: {
+        "jsdoc/check-tag-names": ["warn", { "definedTags": ["experimental"] }],
+      },
     },
   ],
   ignorePatterns: [
diff --git a/ably.d.ts b/ably.d.ts
index 3766e9f595..da7861a80d 100644
--- a/ably.d.ts
+++ b/ably.d.ts
@@ -1164,7 +1164,6 @@ declare namespace Types {
      * Controls the log output of the library. This is a function to handle each line of log output. If you do not set this value, then `console.log` will be used.
      *
      * @deprecated This property is deprecated and will be removed in a future version. Use the {@link ClientOptions.logHandler} client option instead.
-     *
      * @param msg - The log message emitted by the library.
      */
     handler?: (msg: string) => void;
@@ -3101,14 +3100,13 @@ declare namespace Types {
      */
     get(name: string, channelOptions?: ChannelOptions): T;
     /**
+     * Creates a new {@link ChannelBase} or {@link RealtimeChannelBase} object, with the specified channel {@link DeriveOptions}
+     * and {@link ChannelOptions}, or returns the existing channel object.
+     *
      * @experimental This is a preview feature and may change in a future non-major release.
      * This experimental method allows you to create custom realtime data feeds by selectively subscribing
      * to receive only part of the data from the channel.
      * See the [announcement post](https://pages.ably.com/subscription-filters-preview) for more information.
-     *
-     * Creates a new {@link ChannelBase} or {@link RealtimeChannelBase} object, with the specified channel {@link DeriveOptions}
-     * and {@link ChannelOptions}, or returns the existing channel object.
-     *
      * @param name - The channel name.
      * @param deriveOptions - A {@link DeriveOptions} object.
      * @param channelOptions - A {@link ChannelOptions} object.