Skip to content

Commit 38e93d4

Browse files
authored
Prettify docs (#177)
# Motivation <!-- Why is this change necessary? --> # Content <!-- Please include a summary of the change --> # Testing <!-- How was the change tested? --> # Please check the following before marking your PR as ready for review - [ x] I have added tests for my changes - [x ] I have updated the documentation or added new documentation as needed - [ x] I have read and agree to the [Contributor License Agreement](../CLA.md) Co-authored-by: KopekC <[email protected]>
1 parent e3fdc4c commit 38e93d4

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/tutorials/migrating-apis.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ old_param.rename("data")
2525
# process_data(input="test") -> process_data(data="test")
2626
```
2727

28+
<Info>See [dependencies and usages](/building-with-codegen/dependencies-and-usages) for more on updating parameter names and types.</Info>
29+
2830
### Adding Required Parameters
2931

3032
When adding a new required parameter to an API:
@@ -41,6 +43,8 @@ for call in call_sites:
4143
call.add_argument("timeout=30") # Add with a default value
4244
```
4345

46+
<Info>See [function calls and callsites](/building-with-codegen/function-calls-and-callsites) for more on handling call sites.</Info>
47+
4448
### Changing Parameter Types
4549

4650
When updating parameter types:
@@ -58,6 +62,8 @@ for call in api_function.call_sites:
5862
arg.edit(f"UUID({arg.value})")
5963
```
6064

65+
<Info>See [working with type annotations](/building-with-codegen/type-annotations) for more on changing parameter types.</Info>
66+
6167
### Deprecating Functions
6268

6369
When deprecating an old API in favor of a new one:

0 commit comments

Comments
 (0)