diff --git a/starlark-rust/starlark/src/docs/markdown.rs b/starlark-rust/starlark/src/docs/markdown.rs index c2ebf42bcfb86..ec321a3718469 100644 --- a/starlark-rust/starlark/src/docs/markdown.rs +++ b/starlark-rust/starlark/src/docs/markdown.rs @@ -288,7 +288,7 @@ fn render_function_prototype( // example: //
//
-// def soome_function() -> Artifact
+// def soome_function() -> Artifact
//
//
fn render_code_block(contents: &str, render_config: &TypeRenderConfig) -> String {
diff --git a/starlark-rust/starlark/src/docs/multipage.rs b/starlark-rust/starlark/src/docs/multipage.rs
index ad720a9284363..543d1cb98b9e2 100644
--- a/starlark-rust/starlark/src/docs/multipage.rs
+++ b/starlark-rust/starlark/src/docs/multipage.rs
@@ -95,13 +95,19 @@ struct PageRender<'a> {
impl<'a> PageRender<'a> {
fn render_markdown(&self, render_config: &TypeRenderConfig) -> String {
- match self.page {
+ let content = match self.page {
DocPageRef::Module(doc_module) => {
doc_module.render_markdown_page_for_multipage_render(&self.name, render_config)
}
DocPageRef::Type(doc_type) => {
doc_type.render_markdown_page_for_multipage_render(&self.name, render_config)
}
+ };
+ match render_config {
+ TypeRenderConfig::Default => content,
+ TypeRenderConfig::LinkedType { ty_to_path_map: _ } => {
+ format!("{}\n\n{}", "import Link from '@docusaurus/Link';", content)
+ }
}
}
}
diff --git a/starlark-rust/starlark/src/docs/tests/golden/multipage_linked_type/Magic.golden.md b/starlark-rust/starlark/src/docs/tests/golden/multipage_linked_type/Magic.golden.md
index 6ccef1293f114..0fe585213078e 100644
--- a/starlark-rust/starlark/src/docs/tests/golden/multipage_linked_type/Magic.golden.md
+++ b/starlark-rust/starlark/src/docs/tests/golden/multipage_linked_type/Magic.golden.md
@@ -4,6 +4,8 @@
# STARLARK_RUST_REGENERATE_GOLDEN_TESTS=1 cargo test -p starlark --lib
# ```
+import Link from '@docusaurus/Link';
+
# Magic
def Magic(a1: int, a2: int = ..., step: int = 1, /) -> str
diff --git a/starlark-rust/starlark/src/docs/tests/golden/multipage_linked_type/Obj.golden.md b/starlark-rust/starlark/src/docs/tests/golden/multipage_linked_type/Obj.golden.md
index a72f94b0fa2b7..ac7152977be2d 100644
--- a/starlark-rust/starlark/src/docs/tests/golden/multipage_linked_type/Obj.golden.md
+++ b/starlark-rust/starlark/src/docs/tests/golden/multipage_linked_type/Obj.golden.md
@@ -4,6 +4,8 @@
# STARLARK_RUST_REGENERATE_GOLDEN_TESTS=1 cargo test -p starlark --lib
# ```
+import Link from '@docusaurus/Link';
+
# Obj
These are where the module docs go
diff --git a/starlark-rust/starlark/src/docs/tests/golden/multipage_linked_type/globals.golden.md b/starlark-rust/starlark/src/docs/tests/golden/multipage_linked_type/globals.golden.md
index 9f79fc13e1a55..45a640232dcdc 100644
--- a/starlark-rust/starlark/src/docs/tests/golden/multipage_linked_type/globals.golden.md
+++ b/starlark-rust/starlark/src/docs/tests/golden/multipage_linked_type/globals.golden.md
@@ -4,6 +4,8 @@
# STARLARK_RUST_REGENERATE_GOLDEN_TESTS=1 cargo test -p starlark --lib
# ```
+import Link from '@docusaurus/Link';
+
# globals
## MAGIC
@@ -43,7 +45,7 @@ The string 'func1'
b: int,
*,
c: int,
-) -> magic
+) -> magic
---
diff --git a/starlark-rust/starlark/src/docs/tests/golden/multipage_linked_type/submod.golden.md b/starlark-rust/starlark/src/docs/tests/golden/multipage_linked_type/submod.golden.md
index f9c84cc151e60..f4b864b18ee61 100644
--- a/starlark-rust/starlark/src/docs/tests/golden/multipage_linked_type/submod.golden.md
+++ b/starlark-rust/starlark/src/docs/tests/golden/multipage_linked_type/submod.golden.md
@@ -4,11 +4,13 @@
# STARLARK_RUST_REGENERATE_GOLDEN_TESTS=1 cargo test -p starlark --lib
# ```
+import Link from '@docusaurus/Link';
+
# submod
## new\_obj
-def new_obj() -> obj
+def new_obj() -> obj
---
diff --git a/starlark-rust/starlark/src/typing/starlark_value.rs b/starlark-rust/starlark/src/typing/starlark_value.rs
index d4eeda92f88f5..c0ea3f35a578b 100644
--- a/starlark-rust/starlark/src/typing/starlark_value.rs
+++ b/starlark-rust/starlark/src/typing/starlark_value.rs
@@ -350,7 +350,7 @@ impl TyStarlarkValue {
if let Some(link_path) =
ty_to_path_map.get(&Ty::basic(TyBasic::StarlarkValue(self.dupe())))
{
- write!(f, "{type_name}")
+ write!(f, "{type_name}")
} else {
write!(f, "{}", type_name)
}