Skip to content

Commit dc9c4e2

Browse files
author
Carlos
committed
Enhance documentation for built-in functions and types
- Added descriptions and links for the `float()`, `format()`, and `frozenset()` functions. - Improved explanations and added links in `getattr()`, `globals()`, `hasattr()`, `hash()`, `help()`, `hex()`, `id()`, `import()`, `input()`, `int()`, `isinstance()`, `issubclass()`, `iter()`, `len()`, `list()`, `locals()`, `map()`, `max()`, `memoryview()`, `min()`, `next()`, `object()`, `oct()`, `open()`, `ord()`, `pow()`, `print()`, `property()`, `range()`, `repr()`, `reversed()`, `round()`, `set()`, `setattr()`, `slice()`, `sorted()`, `staticmethod()`, `str()`, `sum()`, `super()`, `tuple()`, `type()`, `vars()`, and `zip()` functions. - Added "See also" sections with relevant links for better navigation and understanding of related functions and concepts.
1 parent a10f944 commit dc9c4e2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+446
-72
lines changed

docs/builtin/abs.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,9 @@ Python abs() built-in function
3434
>>> abs(0o20)
3535
# 16
3636
```
37+
38+
## See Also
39+
40+
- <router-link :to="'/builtin/float'">float()</router-link>
41+
- <router-link :to="'/builtin/int'">`int()`</router-link>
42+
- <router-link :to="'/builtin/complex'">complex()</router-link>

docs/builtin/aiter.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,7 @@ Python aiter() built-in function
2525
... results.append(x)
2626
... return iter(results)
2727
```
28+
29+
## See Also
30+
31+
- <router-link :to="'/builtin/iter'">iter()</router-link>

docs/builtin/all.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,7 @@ Python all() built-in function
2828
>>> all({1, 1, 1})
2929
# True
3030
```
31+
32+
## See Also
33+
34+
- <router-link :to="'/builtin/any'">any()</router-link>

docs/builtin/any.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,7 @@ Python any() built-in function
2828
>>> any({0, 0, 0})
2929
# False
3030
```
31+
32+
## See Also
33+
34+
- <router-link :to="'/builtin/all'">all()</router-link>

docs/builtin/ascii.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,8 @@ Python ascii() built-in function
2828
>>> ascii(['A', 'ë'])
2929
# ['A', '\xeb']
3030
```
31+
32+
## See Also
33+
34+
- <router-link :to="'/builtin/repr'">repr()</router-link>
35+
- <router-link :to="'/builtin/str'">str()</router-link>

docs/builtin/bin.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,9 @@ print(bin(10)) # Output: 0b1010
3333
print(bin(100)) # Output: 0b1100100
3434
print(bin(1000)) # Output: 0b1111101000
3535
```
36+
37+
## See Also
38+
39+
- <router-link :to="'/builtin/int'">int()</router-link>
40+
- <router-link :to="'/builtin/hex'">hex()</router-link>
41+
- <router-link :to="'/builtin/oct'">oct()</router-link>

docs/builtin/bool.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,7 @@ Python bool() built-in function
3737
>>> bool(True)
3838
# True
3939
```
40+
41+
## See Also
42+
43+
- <router-link :to="'/builtin/int'">int()</router-link>

docs/builtin/breakpoint.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,7 @@ Python breakpoint() built-in function
3737
# -> for i in range(5):
3838
# (Pdb)
3939
```
40+
41+
## See Also
42+
43+
- <router-link :to="'/modules/pdb'">pdb module</router-link>

docs/builtin/bytearray.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,7 @@ Another way is to use the bytes() function and then convert it to a bytearray ob
4040
# bytearray(b'Hello, World!')
4141
```
4242

43-
Bytearray objects are useful in situations where you need to manipulate binary data or when you want to efficiently modify large amounts of data.
43+
## See Also
44+
45+
- <router-link :to="'/builtin/bytes'">bytes()</router-link>
46+
- <router-link :to="'/builtin/memoryview'">memoryview()</router-link>

docs/builtin/bytes.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ print(data)
3737
# b'Hello, World!'
3838
```
3939

40-
You can also use slicing and indexing to access individual bytes, and use built-in methods such as `count()` and `find()` to search for specific bytes within the object.
40+
## See Also
4141

42-
The `bytes` type is useful when you need to work with binary data that should not be modified, such as the contents of a file. Since it is immutable, it can be used in situations where the data needs to be protected from accidental modification.
42+
- <router-link :to="'/builtin/bytearray'">bytearray()</router-link>
43+
- <router-link :to="'/builtin/memoryview'">memoryview()</router-link>

0 commit comments

Comments
 (0)