summaryrefslogtreecommitdiff
path: root/docs/dev
diff options
context:
space:
mode:
authorZichuan Li <34680029+river-li@users.noreply.github.com>2024-05-24 11:53:02 -0400
committerZichuan Li <34680029+river-li@users.noreply.github.com>2024-05-24 15:50:16 -0400
commit74920c190c5c6230833be6d50536119ce5e44c98 (patch)
tree0c763152792fac5782edd931ab91ab1786365c73 /docs/dev
parent99a857393b90457366f55e39e42364f02e3e10b4 (diff)
Fix the method name in doc
The parameter name is not correct
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/annotation.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/dev/annotation.md b/docs/dev/annotation.md
index abdf91c1..c75ca775 100644
--- a/docs/dev/annotation.md
+++ b/docs/dev/annotation.md
@@ -142,18 +142,18 @@ Though convenient it is many orders of magnitude slower than simply calling the
```python
Type.int(4) # Creates a 4 byte signed integer
Type.int(8, False) # Creates an 8 bytes unsigned integer
-Type.int(2, altName="short") # Creates a 2 byte signed integer named 'short'
+Type.int(2, alternate_name="short") # Creates a 2 byte signed integer named 'short'
# Similarly through their classes directly
IntegerType.create(4)
IntegerType.create(8, False)
-IntegerType.create(2, altName="short")
+IntegerType.create(2, alternate_name="short")
```
#### Character Types
```python
Type.char() # This is just a 1 byte signed integer and can be used as such
-Type.wideChar(2, altName="wchar_t") # Creates a wide character with the name 'wchar_t'
+Type.wide_char(2, alternate_name="wchar_t") # Creates a wide character with the name 'wchar_t'
# Similarly through their classes directly
CharType.create()
WideCharType.create(2)