diff --git a/README.md b/README.md index 96af1417..f3530ca0 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ You have two options to integrate pkpy into your project. #### Use the single header file Download the `pocketpy.h` on our [GitHub Release](https://github.com/pocketpy/pocketpy/releases) page. -And `#include` it in your project. It is recommended to use the latest dev version. +And `#include` it in your project. The header can only be included once. #### Use CMake diff --git a/docs/features/debugging.md b/docs/features/debugging.md index dfbf5048..aaae3279 100644 --- a/docs/features/debugging.md +++ b/docs/features/debugging.md @@ -3,8 +3,11 @@ icon: dot title: Debugging --- -After `v1.4.5`, you can invoke `breakpoint()` in your python code -to start a PDB-like session. +!!! +This feature is available in `v1.4.5` or higher. +!!! + +You can invoke `breakpoint()` in your python code to start a PDB-like session. The following commands are supported: diff --git a/docs/features/goto.md b/docs/features/goto.md index acd4e45f..e5c77fd2 100644 --- a/docs/features/goto.md +++ b/docs/features/goto.md @@ -5,10 +5,6 @@ title: Goto Statement pkpy supports goto/label just like C. You are allowed to **change the control flow unconditionally**. -!!! -This feature is stable after v1.2.2. -!!! - ## Define a label ``` diff --git a/docs/features/long.md b/docs/features/long.md index b52a9084..90007f1e 100644 --- a/docs/features/long.md +++ b/docs/features/long.md @@ -8,11 +8,6 @@ Unlike cpython, pkpy's `int` is of limited precision (64-bit). For arbitrary sized integers, we provide a builtin `long` type, just like python2's `long`. `long` is implemented via pure python in [_long.py](https://github.com/pocketpy/pocketpy/blob/main/python/_long.py). -!!! -This feature is still under development. -Some operations are missing, and some operations are not optimized. -!!! - ### Create a long object You can use `L` suffix to create a `long` literal from a decimal literal. diff --git a/docs/quick-start/attr.md b/docs/quick-start/attr.md index b8154c2f..202edf3d 100644 --- a/docs/quick-start/attr.md +++ b/docs/quick-start/attr.md @@ -69,4 +69,4 @@ std::cout << result << std::endl; // 3 #### `void setattr(PyObject*, StrName, PyObject*)` This method is equivalent to `setattr` in python. -It raises `TypeError` if the object does not support attribute assignment. \ No newline at end of file +It raises `TypeError` if the object does not support attribute assignment. diff --git a/docs/quick-start/installation.md b/docs/quick-start/installation.md index d2a59dd8..f92e48a1 100644 --- a/docs/quick-start/installation.md +++ b/docs/quick-start/installation.md @@ -9,7 +9,7 @@ You have two options to integrate pkpy into your project. #### Use the single header file Download the `pocketpy.h` on our [GitHub Release](https://github.com/pocketpy/pocketpy/releases) page. -And `#include` it in your project. It is recommended to use the latest dev version. +And `#include` it in your project. The header can only be included once. #### Use CMake diff --git a/docs/retype.yml b/docs/retype.yml index af69f4be..0f492264 100644 --- a/docs/retype.yml +++ b/docs/retype.yml @@ -3,7 +3,7 @@ output: .retype url: https://pocketpy.dev branding: title: pocketpy - label: v1.4.5 + label: v1.4.6 logo: "./static/logo.png" favicon: "./static/logo.png" meta: