Skip to content

Commit

Permalink
[Docs] Fix placement of tilde character (#28913)
Browse files Browse the repository at this point in the history
Fix placement of tilde character
  • Loading branch information
khipp authored and Ita Zaporozhets committed May 14, 2024
1 parent 380bc26 commit 5f03332
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 5f03332

Please sign in to comment.