docs: use typedoc default HTML output (#59)

This transitions the node binding's API docs to use typedoc's default HTML output.

Most hyperlinks to node binding's API docs' remain intact (compared to previous deployments on npm.org).

I'm not overly excited about the typedoc organization of the API members, but at least they look familiar to node.js devs that are accustomed to reading typedoc-generated docs.

I also found some typos in the doc comments during local review, so there are some fixes in the docs' content also.

Lastly,  spellings are checked in a pre-commit hook.

Author: 2bndy5

.config/nextest.toml

@@ -15,7 +15,7 @@ slow-timeout = "10s"
 # This is all tests in tests/ folder + unit test for --extra-args.
 default-filter = "all()"
 
-# show wich tests were skipped
+# show which tests were skipped
 status-level = "skip"
 
 # show log output from each test

.github/workflows/bump-n-release.yml

@@ -4,6 +4,10 @@ on:
   workflow_dispatch:
     inputs:
       package:
+        description: >-
+          The package to deploy.
+          Binding packages are named `rf24-<lang>` for simplicity,
+          even if the actual deployed package name is different.
         type: choice
         required: true
         options:
@@ -14,6 +18,7 @@ on:
           # - 'rf24network-rs'
           # - 'rf24mesh-rs'
       bump-component:
+        description: The semantic version component to increase by 1.
         type: choice
         default: 'patch'
         required: true

.github/workflows/bump_version.py

@@ -28,7 +28,6 @@ class _PkgPaths(NamedTuple):
     "README.md",
     ".gitattributes",
     ".gitignore",
-    "justfile",
     ".pre-commit-config.yaml",
     "crates/README.md",
     "package.json",

.pre-commit-config.yaml

@@ -23,3 +23,7 @@ repos:
     - id: ruff
     # Run the formatter.
     - id: ruff-format
+- repo: https://github.com/streetsidesoftware/cspell-cli
+  rev: v9.0.1
+  hooks:
+    - id: cspell # Spell check changed files

bindings/node/src/fake_ble/mod.rs

@@ -6,11 +6,14 @@ pub mod services;
 /// Returns a {@link RadioConfig} object tailored for
 /// OTA compatibility with BLE specifications.
 ///
-/// !!! note "See also"
-///     This configuration complies with inherent
-///     [Limitations](https://docs.rs/rf24ble-rs/latest/rf24ble/index.html#limitations).
+/// > [!NOTE]
+/// > This configuration complies with inherent
+/// > [Limitations](https://docs.rs/rf24ble-rs/latest/rf24ble/index.html#limitations).
 #[napi]
-#[allow(dead_code)]
+#[allow(
+    dead_code,
+    reason = "function is exported publicly in generated binding"
+)]
 pub fn ble_config() -> RadioConfig {
     RadioConfig::from_inner(rf24ble::ble_config())
 }

bindings/node/src/fake_ble/radio.rs

@@ -11,23 +11,23 @@ use super::services::BlePayload;
 
 /// A class to use the nRF24L01 as a Fake BLE beacon.
 ///
-/// !!! note "See also"
-///     This implementation is subject to
-///     [Limitations](https://docs.rs/rf24ble-rs/latest/rf24ble/index.html#limitations).
+/// > [!NOTE]
+/// > This implementation is subject to
+/// > [Limitations](https://docs.rs/rf24ble-rs/latest/rf24ble/index.html#limitations).
 ///
-///     Use {@link bleConfig} to properly configure the radio for
-///     BLE compatibility.
+/// Use {@link bleConfig} to properly configure the radio for
+/// BLE compatibility.
 ///
-///     ```ts
-///     import { bleConfig, FakeBle, RF24 } from "@rf24/rf24";
+/// ```ts
+/// import { bleConfig, FakeBle, RF24 } from "@rf24/rf24";
 ///
-///     const radio = new RF24(22, 0);
-///     radio.begin();
-///     radio.withConfig(bleConfig());
-///     const ble = new FakeBle(radio);
+/// const radio = new RF24(22, 0);
+/// radio.begin();
+/// radio.withConfig(bleConfig());
+/// const ble = new FakeBle(radio);
 ///
-///     radio.printDetails();
-///     ```
+/// radio.printDetails();
+/// ```
 #[napi]
 pub struct FakeBle {
     radio: Reference<RF24>,
@@ -184,7 +184,7 @@ impl FakeBle {
     /// Use {@link RF24.available} to check if there is data in the radio's RX FIFO.
     ///
     /// If the payload was somehow malformed or incomplete,
-    /// then this function returns an undefined value.
+    /// then this function returns an `undefined` value.
     #[napi]
     pub fn read(&mut self) -> Result<Option<BlePayload>> {
         let mut buf = self.radio.read(Some(32))?;

bindings/node/src/radio/config.rs

@@ -47,7 +47,7 @@ impl RadioConfig {
     /// |    4[^2]    | closed | `0xC5`      |
     /// |    5[^2]    | closed | `0xC6`      |
     ///
-    /// [^1]: The RX address default value is the same as pipe 0 default RX address.
+    /// [^1]: The RX address default value is the same as pipe 0 default TX address.
     /// [^2]: Remember, pipes 2 - 5 share the same 4 LSBytes as the address on pipe 1.
     #[napi(constructor)]
     pub fn new() -> Self {

bindings/python/src/radio/config.rs

@@ -38,7 +38,7 @@ use std::borrow::Cow;
 /// |      4[^2]  | closed | `0xC5`        |
 /// |      5[^2]  | closed | `0xC6`        |
 ///
-/// [^1]: The RX address default value is the same as pipe 0 default RX address.
+/// [^1]: The RX address default value is the same as pipe 0 default TX address.
 /// [^2]: Remember, pipes 2 - 5 share the same 4 LSBytes as the address on pipe 1.
 #[pyclass(module = "rf24_py")]
 #[derive(Debug, Clone, Copy)]

crates/rf24-rs/src/radio/config.rs

@@ -72,7 +72,9 @@ impl EsbPipeConfig {
 /// This struct follows a builder pattern. Since all fields are private, users should
 /// start with the [`RadioConfig::default`] constructor, then mutate the object accordingly.
 /// ```
-/// let mut config = Config::default();
+/// use rf24::radio::RadioConfig;
+///
+/// let mut config = RadioConfig::default();
 /// config = config.with_channel(42);
 /// ```
 #[derive(Debug, Clone, Copy)]
@@ -123,7 +125,7 @@ impl Default for RadioConfig {
     /// |      5[^1]  | closed | `0xC6`      |
     ///
     /// [^1]: Remember, pipes 2 - 5 share the same 4 LSBytes as the address on pipe 1.
-    /// [^2]: The RX address default value is the same as pipe 0 default RX address.
+    /// [^2]: The RX address default value is the same as pipe 0 default TX address.
     fn default() -> Self {
         Self {
             /*
@@ -382,6 +384,8 @@ impl RadioConfig {
     ///
     /// To enable the feature for pipes 0, 1 and 4:
     /// ```
+    /// use rf24::radio::RadioConfig;
+    ///
     /// let config = RadioConfig::default().with_auto_ack(0b010011);
     /// ```
     /// If enabling the feature for any pipe other than 0, then the pipe 0 should also have the

crates/rf24-rs/src/radio/rf24/details.rs

@@ -220,9 +220,9 @@ where
         std::println!("    Data Fail triggered___{}", self.status.tx_df());
 
         let fifo = self.get_fifo_state(true)?;
-        std::println!("TX FIFO___________________{}", fifo);
+        std::println!("TX FIFO___________________{fifo}");
         let fifo = self.get_fifo_state(false)?;
-        std::println!("RX FIFO___________________{}", fifo);
+        std::println!("RX FIFO___________________{fifo}");
 
         self.spi_read(1, registers::FEATURE)?;
         let features = self.buf[1];