ByoungSooPark/modeling-app
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More docs fixes (#6733)

Browse Source 
* Fix various docs errors around std module

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* remove KCL from lang docs titles and move settings docs

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Include functions declared in Rust in module docs

Signed-off-by: Nick Cameron <nrc@ncameron.org>

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
This commit is contained in:
Nick Cameron
2025-05-08 08:26:56 +12:00
committed by GitHub
parent 43d5a72514
commit 2fee3a424c
84 changed files with 203 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
rust/kcl-lib/src/docs/kcl_doc.rs
View File

@ -117,8 +117,10 @@ fn visit_module(name: &str, preferred_prefix: &str, names: WalkForNames) -> Resu
}
let qual = format!("{}::", &result.qual_name);
let mut dd = match var.kind {
VariableKind::Fn => DocData::Fn(FnData::from_ast(var, qual, preferred_prefix, name)),
VariableKind::Const => DocData::Const(ConstData::from_ast(var, qual, preferred_prefix, name)),
VariableKind::Fn => DocData::Fn(FnData::from_ast(var, qual, preferred_prefix, &result.name)),
VariableKind::Const => {
DocData::Const(ConstData::from_ast(var, qual, preferred_prefix, &result.name))
}
};
let key = format!("I:{}", dd.qual_name());
if result.children.contains_key(&key) {
@ -138,7 +140,7 @@ fn visit_module(name: &str, preferred_prefix: &str, names: WalkForNames) -> Resu
continue;
}
let qual = format!("{}::", &result.qual_name);
let mut dd = DocData::Ty(TyData::from_ast(ty, qual, preferred_prefix, name));
let mut dd = DocData::Ty(TyData::from_ast(ty, qual, preferred_prefix, &result.name));
let key = format!("T:{}", dd.qual_name());
if result.children.contains_key(&key) {
continue;
@ -452,10 +454,10 @@ pub struct ModData {
impl ModData {
fn new(name: &str, preferred_prefix: &str) -> Self {
let (qual_name, module_name) = if name == "prelude" {
("std".to_owned(), String::new())
let (name, qual_name, module_name) = if name == "prelude" {
("std", "std".to_owned(), String::new())
} else {
(format!("std::{}", name), "std".to_owned())
(name, format!("std::{}", name), "std".to_owned())
};
Self {
preferred_name: format!("{preferred_prefix}{name}"),