docs: mark all entities from 1.6.0 as not released yet and add link c…

…heck in the doc comments (#1836)
tact-lang · Feb 14, 2025 · 453bafe · 453bafe
1 parent 4bcc0aa
commit 453bafe
Show file tree

Hide file tree

Showing 8 changed files with 54 additions and 37 deletions.
diff --git a/.github/workflows/external-links.yml b/.github/workflows/external-links.yml
@@ -42,3 +42,20 @@ jobs:
           output: "/dev/stdout"
           fail: true
           failIfEmpty: false
+
+  linkcheck-stdlib:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: (stdlib) Check broken HTTP(S) links in doc comments
+        uses: lycheeverse/lychee-action@v2
+        id: lychee_dev
+        with:
+          args: >
+            -n -s https -s http
+            './src/stdlib/stdlib/**/*.tact'
+          output: "/dev/stdout"
+          fail: true
+          failIfEmpty: false
diff --git a/docs/src/content/docs/book/config.mdx b/docs/src/content/docs/book/config.mdx
@@ -339,7 +339,7 @@ If set to `true{:json}`, enables inlining of all functions in contracts. This ca
 
 #### `safety` {#options-safety}
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 Options that affect the safety of contracts.
 
@@ -360,7 +360,7 @@ Options that affect the safety of contracts.
 
 ##### `nullChecks` {#safety-nullChecks}
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 `true{:json}` by default.
 
@@ -387,7 +387,7 @@ Null checks are always enabled in the [`debug`](#options-debug) mode.
 
 #### `enableLazyDeploymentCompletedGetter` {#options-enablelazydeploymentcompletedgetter}
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 `false{:json}` by default.
 
@@ -410,7 +410,7 @@ If set to `true{:json}`, enables generation of `lazy_deployment_completed()` get
 
 ### `verbose` {#verbose}
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 `1{:json}` by default.
 

diff --git a/docs/src/content/docs/book/receive.mdx b/docs/src/content/docs/book/receive.mdx
@@ -20,7 +20,7 @@ There are several receiver functions. All receiver functions are processed in th
 * `receive(msg: MyMessage){:tact}` - called when a binary message of type `MyMessage` is sent to the contract
 * `receive(msg: Slice){:tact}` - called when binary message of unknown type is sent to the contract
 
-For example, an empty message gets processed by `receive(){:tact}` and not by `receive(msg: Slice){:tact}`, because the former occurs before the later in the above list. Similarly, a message with specific comment `"message"{:tact}` gets processed by `receive("message"){:tact}` and not by `receive(str: String){:tact}`.
+For example, an empty message gets processed by `receive(){:tact}` and not by `receive(msg: Slice){:tact}`, because the former occurs before the latter in the above list. Similarly, a message with specific comment `"message"{:tact}` gets processed by `receive("message"){:tact}` and not by `receive(str: String){:tact}`.
 
 ```tact
 message MyMessage {

diff --git a/docs/src/content/docs/ref/core-advanced.mdx b/docs/src/content/docs/ref/core-advanced.mdx
@@ -278,7 +278,7 @@ let origFee: Int = getOriginalFwdFee(fee, false);
 
 ## setGasLimit
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 fun setGasLimit(limit: Int);
@@ -349,7 +349,7 @@ throw(42); // and this won't fail it
 
 ## myCode
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 fun myCode(): Cell;
@@ -393,7 +393,7 @@ let dataStorageFeeConfig: Cell = getConfigParam(18)!!;
 
 ## getSeed
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 fun getSeed(): Int;
@@ -420,7 +420,7 @@ setSeed(seed); // from now on the results of pseudorandom number generator
 
 ## setSeed
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 fun setSeed(seed: Int);
@@ -448,7 +448,7 @@ setSeed(seed); // from now on the results of pseudorandom number generator
 
 ## curLt
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 fun curLt(): Int;
@@ -473,7 +473,7 @@ nativeRandomize(lt); // equivalent to calling nativeRandomizeLt()
 
 ## blockLt
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 fun blockLt(): Int;

diff --git a/docs/src/content/docs/ref/core-cells.mdx b/docs/src/content/docs/ref/core-cells.mdx
@@ -94,7 +94,7 @@ let fizz: Slice = c.beginParse();
 
 ### Cell.depth
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 extends fun depth(self: Cell?): Int;
@@ -114,7 +114,7 @@ let depth: Int = c.depth(); // 0
 ### Cell.computeDataSize
 
 <Badge text="Gas-expensive" title="Uses 500 gas units or more" variant="danger" size="medium"/>
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 extends fun computeDataSize(self: Cell?, maxCells: Int): DataSize;
@@ -347,7 +347,7 @@ let fizz: Builder = b.storeCoins(42);
 
 ### Builder.storeVarUint16
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 extends fun storeVarUint16(self: Builder, value: Int): Builder;
@@ -370,7 +370,7 @@ let fizz: Builder = b.storeVarUint16(42);
 
 ### Builder.storeVarInt16
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 extends fun storeVarInt16(self: Builder, value: Int): Builder;
@@ -397,7 +397,7 @@ let fizz: Builder = b.storeVarInt16(-42);
 
 ### Builder.storeVarUint32
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 extends fun storeVarUint32(self: Builder, value: Int): Builder;
@@ -424,7 +424,7 @@ let fizz: Builder = b.storeVarUint32(420000);
 
 ### Builder.storeVarInt32
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 extends fun storeVarInt32(self: Builder, value: Int): Builder;
@@ -546,7 +546,7 @@ let fizz: Int = b.bits(); // 0
 
 ### Builder.depth
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 extends fun depth(self: Builder): Int;
@@ -757,7 +757,7 @@ let fizz: Slice = s.loadBits(1); // load only 1 bit
 
 ### Slice.skipLastBits
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 extends fun skipLastBits(self: Slice, len: Int);
@@ -846,7 +846,7 @@ let fizz: Int = s.loadCoins(); // 42
 
 ### Slice.loadVarUint16
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 extends mutates fun loadVarUint16(self: Slice): Int;
@@ -869,7 +869,7 @@ let fizz: Int = s.loadVarUint16(); // 42
 
 ### Slice.loadVarInt16
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 extends mutates fun loadVarInt16(self: Slice): Int;
@@ -898,7 +898,7 @@ let fizz: Int = s.loadVarInt16(); // -42
 
 ### Slice.loadVarUint32
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 extends mutates fun loadVarUint32(self: Slice): Int;
@@ -925,7 +925,7 @@ let fizz: Int = s.loadVarUint32(); // 420000
 
 ### Slice.loadVarInt32
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 extends mutates fun loadVarInt32(self: Slice): Int;
@@ -1065,7 +1065,7 @@ let fizz: Int = s.bits();
 
 ### Slice.firstBits
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 extends fun firstBits(self: Slice, len: Int): Slice;
@@ -1094,7 +1094,7 @@ let firstFive: Slice = s.firstBits(5); // first 5 bits
 
 ### Slice.lastBits
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 extends fun lastBits(self: Slice, len: Int): Slice;
@@ -1117,7 +1117,7 @@ let lastFive: Slice = s.lastBits(5); // last 5 bits
 
 ### Slice.depth
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 extends fun depth(self: Slice): Int;
@@ -1137,7 +1137,7 @@ let depth: Int = s.depth(); // 0
 ### Slice.computeDataSize
 
 <Badge text="Gas-expensive" title="Uses 500 gas units or more" variant="danger" size="medium"/>
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 extends fun computeDataSize(self: Slice, maxCells: Int): DataSize;

diff --git a/docs/src/content/docs/ref/core-math.mdx b/docs/src/content/docs/ref/core-math.mdx
@@ -63,7 +63,7 @@ abs(-(-(-42))); // 42
 
 ## sign
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 fun sign(x: Int): Int;
@@ -84,7 +84,7 @@ sign(0);         // 0
 ## sqrt
 
 <Badge text="Gas-expensive" title="Uses 500 gas units or more" variant="danger" size="medium"/>
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 fun sqrt(num: Int): Int;
@@ -107,7 +107,7 @@ sqrt(-1); // ERROR! Exit code 5: Integer out of expected range
 
 ## divc
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 fun divc(x: Int, y: Int): Int;
@@ -128,7 +128,7 @@ divc(-3, 2); // -1
 
 ## muldivc
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 fun muldivc(x: Int, y: Int, z: Int): Int;
@@ -151,7 +151,7 @@ muldivc(-3, 0, 0); // ERROR! Exit code 4: Integer overflow
 
 ## mulShiftRight
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 fun mulShiftRight(x: Int, y: Int, z: Int): Int;
@@ -174,7 +174,7 @@ mulShiftRight(5, 5, -1); // ERROR! Exit code 5: Integer out of expected range
 
 ## mulShiftRightRound
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 fun mulShiftRightRound(x: Int, y: Int, z: Int): Int;
@@ -197,7 +197,7 @@ mulShiftRightRound(5, 5, -1); // ERROR! Exit code 5: Integer out of expected ran
 
 ## mulShiftRightCeil
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 ```tact
 fun mulShiftRightCeil(x: Int, y: Int, z: Int): Int;

diff --git a/docs/src/content/docs/zh-cn/book/maps.mdx b/docs/src/content/docs/zh-cn/book/maps.mdx
@@ -98,7 +98,7 @@ if (gotButUnsure != null) {
 
 ### 替换值 `.replace()` {#replace}
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 要替换某个键下的值，如果存在这样的键，请使用 `.replace(){:tact}` [方法](/zh-cn/book/functions#extension-function)。 它在成功替换时返回 `true{:tact}`，否则返回 `false{:tact}`。
 
@@ -140,7 +140,7 @@ replaced2; // false
 
 ### 替换并获取旧值，`.replaceGet()` {#replaceget}
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 类似于 [`.replace()`](#replace)，但在成功替换时返回旧的（替换前的）值，否则返回 [`null{:tact}`](/zh-cn/book/optionals)，而不是返回一个 [`Boolean{:tact}`](/zh-cn/book/types#booleans)。
 

diff --git a/docs/src/content/docs/zh-cn/book/statements.mdx b/docs/src/content/docs/zh-cn/book/statements.mdx
@@ -100,7 +100,7 @@ value += 5;     // augmented assignment (one of the many, see below)
 
 ## 解构赋值
 
-<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+<Badge text="Available since Tact 1.6 (not released yet)" variant="tip" size="medium"/><p/>
 
 解构赋值是一种简洁的方法，可以将[结构][s]和[消息][m]解包为不同的变量。 它镜像了[实例化语法](/zh-cn/book/expressions#instantiation)，但不是创建新的[结构体][s]或[消息][m]，而是将每个字段或部分字段绑定到它们各自的变量。