From 5f03332b0b47d7ae888bbcc07360741a1891da9f Mon Sep 17 00:00:00 2001 From: Klaus Hipp Date: Thu, 8 Feb 2024 02:19:39 +0100 Subject: [PATCH] [Docs] Fix placement of tilde character (#28913) Fix placement of tilde character --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 4e0c00fa2ea2f9..7dbcefc0483c66 100644 --- a/docs/README.md +++ b/docs/README.md @@ -202,7 +202,7 @@ provide its path. For instance: \[\`utils.ModelOutput\`\]. This will be converte `utils.ModelOutput` in the description. To get rid of the path and only keep the name of the object you are linking to in the description, add a ~: \[\`~utils.ModelOutput\`\] will generate a link with `ModelOutput` in the description. -The same works for methods so you can either use \[\`XXXClass.method\`\] or \[~\`XXXClass.method\`\]. +The same works for methods so you can either use \[\`XXXClass.method\`\] or \[\`~XXXClass.method\`\]. #### Defining arguments in a method