From 9c60e8ff8b6b53feadae8c6bdf170408ade55c3e Mon Sep 17 00:00:00 2001
From: naskya <m@naskya.net>
Date: Fri, 24 May 2024 01:19:17 +0900
Subject: [PATCH] chore (backend-rs): address `cargo doc` warnings
---
packages/backend-rs/src/config/constant.rs | 6 +++---
packages/backend-rs/src/service/nodeinfo/schema.rs | 4 ++--
packages/backend-rs/src/util/id.rs | 2 +-
3 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/packages/backend-rs/src/config/constant.rs b/packages/backend-rs/src/config/constant.rs
index 46fe189aca..7f71a230b5 100644
--- a/packages/backend-rs/src/config/constant.rs
+++ b/packages/backend-rs/src/config/constant.rs
@@ -15,9 +15,9 @@ pub const USER_ACTIVE_THRESHOLD: i32 = 3 * DAY;
/// List of file types allowed to be viewed directly in the browser
/// Anything not included here will be responded as application/octet-stream
/// SVG is not allowed because it generates XSS <- we need to fix this and later allow it to be viewed directly
-/// https://github.com/sindresorhus/file-type/blob/main/supported.js
-/// https://github.com/sindresorhus/file-type/blob/main/core.js
-/// https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Containers
+/// <https://github.com/sindresorhus/file-type/blob/main/supported.js>
+/// <https://github.com/sindresorhus/file-type/blob/main/core.js>
+/// <https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Containers>
#[crate::export]
pub const FILE_TYPE_BROWSERSAFE: [&str; 41] = [
// Images
diff --git a/packages/backend-rs/src/service/nodeinfo/schema.rs b/packages/backend-rs/src/service/nodeinfo/schema.rs
index d4469a55e8..b56c84ec70 100644
--- a/packages/backend-rs/src/service/nodeinfo/schema.rs
+++ b/packages/backend-rs/src/service/nodeinfo/schema.rs
@@ -5,7 +5,7 @@ use std::collections::HashMap;
// - #[serde(skip_serializing_if = "Option::is_none")] (https://github.com/3Hren/msgpack-rust/issues/86)
// - #[serde(tag = "version", rename = "2.1")] (https://github.com/3Hren/msgpack-rust/issues/318)
-/// NodeInfo schema version 2.1. https://nodeinfo.diaspora.software/docson/index.html#/ns/schema/2.1
+/// NodeInfo schema version 2.1. <https://nodeinfo.diaspora.software/docson/index.html#/ns/schema/2.1>
#[derive(Deserialize, Serialize, Debug, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct Nodeinfo21 {
@@ -25,7 +25,7 @@ pub struct Nodeinfo21 {
pub metadata: HashMap<String, serde_json::Value>,
}
-/// NodeInfo schema version 2.0. https://nodeinfo.diaspora.software/docson/index.html#/ns/schema/2.0
+/// NodeInfo schema version 2.0. <https://nodeinfo.diaspora.software/docson/index.html#/ns/schema/2.0>
#[derive(Deserialize, Serialize, Debug, PartialEq)]
#[serde(rename_all = "camelCase")]
#[crate::export(object, js_name = "Nodeinfo")]
diff --git a/packages/backend-rs/src/util/id.rs b/packages/backend-rs/src/util/id.rs
index 416716076b..de62cb3128 100644
--- a/packages/backend-rs/src/util/id.rs
+++ b/packages/backend-rs/src/util/id.rs
@@ -66,7 +66,7 @@ pub fn get_timestamp(id: &str) -> Result<i64, InvalidIdError> {
/// With the length of 16, namely 8 for cuid2, roughly 1427399 IDs are needed
/// in the same millisecond to reach 50% chance of collision.
///
-/// Ref: https://github.com/paralleldrive/cuid2#parameterized-length
+/// Ref: <https://github.com/paralleldrive/cuid2#parameterized-length>
#[crate::export]
pub fn gen_id() -> String {
create_id(&Utc::now().naive_utc())