Fix deprecation methods replacement links at Session class (#1046)

The @deprected tag doesn't accept links, so the links were moved to the @see section.
neo4j · Jan 3, 2023 · 28b1907 · 28b1907
1 parent f0646a0
commit 28b1907
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 6 deletions.
diff --git a/packages/core/src/session.ts b/packages/core/src/session.ts
@@ -325,9 +325,10 @@ class Session {
   /**
    * Return the bookmarks received following the last completed {@link Transaction}.
    *
-   * @deprecated This method will be removed in version 6.0. Please, use {@link Session#lastBookmarks} instead.
+   * @deprecated This method will be removed in version 6.0. Please, use Session#lastBookmarks instead.
    *
    * @return {string[]} A reference to a previous transaction.
+   * @see {@link Session#lastBookmarks}
    */
   lastBookmark (): string[] {
     return this.lastBookmarks()
@@ -358,13 +359,14 @@ class Session {
    * delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
    * `maxTransactionRetryTime` property in milliseconds.
    *
-   * @deprecated This method will be removed in version 6.0. Please, use {@link Session#executeRead} instead.
+   * @deprecated This method will be removed in version 6.0. Please, use Session#executeRead instead.
    *
    * @param {function(tx: Transaction): Promise} transactionWork - Callback that executes operations against
    * a given {@link Transaction}.
    * @param {TransactionConfig} [transactionConfig] - Configuration for all transactions started to execute the unit of work.
    * @return {Promise} Resolved promise as returned by the given function or rejected promise when given
    * function or commit fails.
+   * @see {@link Session#executeRead}
    */
   readTransaction<T>(
     transactionWork: TransactionWork<T>,
@@ -382,13 +384,14 @@ class Session {
    * delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
    * `maxTransactionRetryTime` property in milliseconds.
    *
-   * @deprecated This method will be removed in version 6.0. Please, use {@link Session#executeWrite} instead.
+   * @deprecated This method will be removed in version 6.0. Please, use Session#executeWrite instead.
    *
    * @param {function(tx: Transaction): Promise} transactionWork - Callback that executes operations against
    * a given {@link Transaction}.
    * @param {TransactionConfig} [transactionConfig] - Configuration for all transactions started to execute the unit of work.
    * @return {Promise} Resolved promise as returned by the given function or rejected promise when given
    * function or commit fails.
+   * @see {@link Session#executeWrite}
    */
   writeTransaction<T>(
     transactionWork: TransactionWork<T>,

diff --git a/packages/neo4j-driver-deno/lib/core/session.ts b/packages/neo4j-driver-deno/lib/core/session.ts
@@ -325,9 +325,10 @@ class Session {
   /**
    * Return the bookmarks received following the last completed {@link Transaction}.
    *
-   * @deprecated This method will be removed in version 6.0. Please, use {@link Session#lastBookmarks} instead.
+   * @deprecated This method will be removed in version 6.0. Please, use Session#lastBookmarks instead.
    *
    * @return {string[]} A reference to a previous transaction.
+   * @see {@link Session#lastBookmarks}
    */
   lastBookmark (): string[] {
     return this.lastBookmarks()
@@ -358,13 +359,14 @@ class Session {
    * delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
    * `maxTransactionRetryTime` property in milliseconds.
    *
-   * @deprecated This method will be removed in version 6.0. Please, use {@link Session#executeRead} instead.
+   * @deprecated This method will be removed in version 6.0. Please, use Session#executeRead instead.
    *
    * @param {function(tx: Transaction): Promise} transactionWork - Callback that executes operations against
    * a given {@link Transaction}.
    * @param {TransactionConfig} [transactionConfig] - Configuration for all transactions started to execute the unit of work.
    * @return {Promise} Resolved promise as returned by the given function or rejected promise when given
    * function or commit fails.
+   * @see {@link Session#executeRead}
    */
   readTransaction<T>(
     transactionWork: TransactionWork<T>,
@@ -382,13 +384,14 @@ class Session {
    * delay of 1 second and maximum retry time of 30 seconds. Maximum retry time is configurable via driver config's
    * `maxTransactionRetryTime` property in milliseconds.
    *
-   * @deprecated This method will be removed in version 6.0. Please, use {@link Session#executeWrite} instead.
+   * @deprecated This method will be removed in version 6.0. Please, use Session#executeWrite instead.
    *
    * @param {function(tx: Transaction): Promise} transactionWork - Callback that executes operations against
    * a given {@link Transaction}.
    * @param {TransactionConfig} [transactionConfig] - Configuration for all transactions started to execute the unit of work.
    * @return {Promise} Resolved promise as returned by the given function or rejected promise when given
    * function or commit fails.
+   * @see {@link Session#executeWrite}
    */
   writeTransaction<T>(
     transactionWork: TransactionWork<T>,