Skip to content

Commit 920c809

Browse files
committed
📚 fix: 移除 rustdoc::invalid_html_tags 警告并修复文档格式
- 删除 #\![allow(rustdoc::invalid_html_tags)] 提升文档质量标准 - 修复 5 处文档注释中的无效 HTML 标签警告 - 使用代码块格式 `<sheetId>\!<开始单元格>:<结束列>` 替代裸 HTML 标签 - 改善 API 文档的可读性和格式一致性 影响文件: - src/lib.rs: 移除全局 rustdoc 警告忽略 - 3个 sheets API 文档文件:格式化 API 参数说明 验证: - cargo doc --all-features 无警告 - 文档渲染正常,格式更清晰 - 所有 clippy 检查通过
1 parent bdbc23a commit 920c809

File tree

4 files changed

+5
-6
lines changed

4 files changed

+5
-6
lines changed

src/lib.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/README.md"))]
2-
#![allow(rustdoc::invalid_html_tags)]
32
#![allow(rustdoc::broken_intra_doc_links)]
43
#![allow(clippy::uninlined_format_args)]
54

src/service/cloud_docs/sheets/v2/data_operation/reading_a_single_range.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ pub struct ReadingSingleRangeRequest {
1818
/// spreadsheet 的 token
1919
spreadsheet_token: String,
2020
/// 查询范围,包含 sheetId 与单元格范围两部分,详见在线表格开发指南。若查询范围中使用形如
21-
/// <sheetId>!<开始单元格>:<结束列>的范围时,仅支持获取100列数据
21+
/// `<sheetId>!<开始单元格>:<结束列>`的范围时,仅支持获取100列数据
2222
range: String,
2323
/// 指定单元格数据的格式。可选值为如下所示。当参数缺省时,默认不进行公式计算,返回公式本身;
2424
/// 数值不进行数字格式化。
@@ -64,7 +64,7 @@ impl ReadingSingleRangeRequestBuilder {
6464
}
6565

6666
/// 查询范围,包含 sheetId 与单元格范围两部分,详见在线表格开发指南。若查询范围中使用形如
67-
/// <sheetId>!<开始单元格>:<结束列>的范围时,仅支持获取100列数据
67+
/// `<sheetId>!<开始单元格>:<结束列>`的范围时,仅支持获取100列数据
6868
pub fn range(mut self, range: impl ToString) -> Self {
6969
self.request.range = range.to_string();
7070
self

src/service/cloud_docs/sheets/v2/data_operation/reading_multiple_range.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ pub struct ReadingMultipleRangeRequest {
1818
spreadsheet_token: String,
1919
/// 多个查询范围,范围之间使用逗号分隔,如range1,range2。其中 range 包含 sheetId
2020
/// 与单元格范围两部分,目前支持四种索引方式,详见 在线表格开发指南
21-
/// 。若查询范围中使用形如<sheetId>!<开始单元格>:<结束列>的范围时,仅支持获取100列数据
21+
/// 。若查询范围中使用形如`<sheetId>!<开始单元格>:<结束列>`的范围时,仅支持获取100列数据
2222
ranges: String,
2323
/// 指定单元格数据的格式。可选值为如下所示。当参数缺省时,默认不进行公式计算,返回公式本身;
2424
/// 数值不进行数字格式化。
@@ -65,7 +65,7 @@ impl ReadingMultiRangesRequestBuilder {
6565

6666
/// 多个查询范围,范围之间使用逗号分隔,如range1,range2。⁣其中 range 包含 sheetId
6767
/// 与单元格范围两部分,目前支持四种索引方式,详见 在线表格开发指南
68-
/// 。若查询范围中使用形如<sheetId>!<开始单元格>:<结束列>的范围时,仅支持获取100列数据。
68+
/// 。若查询范围中使用形如`<sheetId>!<开始单元格>:<结束列>`的范围时,仅支持获取100列数据。
6969
pub fn ranges(mut self, ranges: impl ToString) -> Self {
7070
self.request.ranges = ranges.to_string();
7171
self.request

src/service/cloud_docs/sheets/v2/data_operation/write_image.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ pub struct WriteImageRequest {
1717
api_request: ApiRequest,
1818
#[serde(skip)]
1919
spreadsheet_token: String,
20-
/// 查询范围 range=<sheetId>!<开始格子>:<结束格子>
20+
/// 查询范围 range=`<sheetId>!<开始格子>:<结束格子>`
2121
/// 如:xxxx!A1:D5,详见在线表格开发指南。此处限定为一个格子,如: xxxx!A1:A1
2222
range: String,
2323
/// 需要写入的图片二进制流,支持 "PNG", "JPEG", "JPG", "GIF", "BMP", "JFIF", "EXIF", "TIFF",

0 commit comments

Comments
 (0)