Skip to content

Commit 4583da6

Browse files
committed
Add relevant links to built-in function documentation
- Updated the "See also" sections in various built-in function documentation files to "Relevant links" for consistency. - Added internal documentation links to related cheatsheets, blog posts, and module documentation for better navigation and reference. - Ensured all links point to existing documentation pages, enhancing the overall usability of the documentation.
1 parent 12cf78e commit 4583da6

Some content is hidden

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

71 files changed

+469
-288
lines changed
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Add relevant internal documentation links to this section by:
2+
3+
1. Cross-referencing the following documentation categories in the `/docs` folder:
4+
- Cheatsheets
5+
- Blog posts
6+
- Module documentation
7+
- Built-in features/APIs
8+
9+
2. Format links using the router-link syntax
10+
11+
3. Ensure all links point to existing documentation pages
12+
13+
## Relevant Links
14+
15+
[Insert links here using the structure above]

docs/builtin/abs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The `abs()` function in Python is a built-in function that returns the absolute
3939
# 16
4040
```
4141

42-
## See Also
42+
## Relevant links
4343

4444
- <router-link :to="'/builtin/float'">float()</router-link>
4545
- <router-link :to="'/builtin/int'">`int()`</router-link>

docs/builtin/aiter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,6 @@ The `aiter()` function in Python is a built-in function that returns an asynchro
3030
... return iter(results)
3131
```
3232

33-
## See Also
33+
## Relevant links
3434

3535
- <router-link :to="'/builtin/iter'">iter()</router-link>

docs/builtin/all.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ The `all()` function in Python is a built-in function that checks if all element
3333
# True
3434
```
3535

36-
## See Also
36+
## Relevant links
3737

3838
- <router-link :to="'/builtin/any'">any()</router-link>
39+
- <router-link :to="'/cheatsheet/control-flow'">Control Flow</router-link>
40+
- <router-link :to="'/cheatsheet/comprehensions'">Comprehensions</router-link>
41+
- <router-link :to="'/blog/python-data-types'">Python Data Types</router-link>

docs/builtin/any.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ The `any()` function in Python is a built-in function that checks if at least on
3333
# False
3434
```
3535

36-
## See Also
36+
## Relevant links
3737

3838
- <router-link :to="'/builtin/all'">all()</router-link>
39+
- <router-link :to="'/cheatsheet/control-flow'">Control Flow</router-link>
40+
- <router-link :to="'/cheatsheet/comprehensions'">Comprehensions</router-link>
41+
- <router-link :to="'/blog/python-data-types'">Python Data Types</router-link>

docs/builtin/ascii.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,10 @@ The `ascii()` function in Python is a built-in function that returns a string co
3333
# ['A', '\xeb']
3434
```
3535

36-
## See Also
36+
## Relevant links
3737

3838
- <router-link :to="'/builtin/repr'">repr()</router-link>
3939
- <router-link :to="'/builtin/str'">str()</router-link>
40+
- <router-link :to="'/builtin/chr'">chr()</router-link>
41+
- <router-link :to="'/builtin/ord'">ord()</router-link>
42+
- <router-link :to="'/cheatsheet/manipulating-strings'">Manipulating Strings</router-link>

docs/builtin/bin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ print(bin(100)) # Output: 0b1100100
3434
print(bin(1000)) # Output: 0b1111101000
3535
```
3636

37-
## See Also
37+
## Relevant links
3838

3939
- <router-link :to="'/builtin/int'">int()</router-link>
4040
- <router-link :to="'/builtin/hex'">hex()</router-link>

docs/builtin/bool.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ The `bool()` function in Python is a built-in function that converts a value to
4242
# True
4343
```
4444

45-
## See Also
45+
## Relevant links
4646

4747
- <router-link :to="'/builtin/int'">int()</router-link>
48+
- <router-link :to="'/builtin/all'">all()</router-link>
49+
- <router-link :to="'/builtin/any'">any()</router-link>
50+
- <router-link :to="'/cheatsheet/control-flow'">Control Flow</router-link>
51+
- <router-link :to="'/blog/python-data-types'">Python Data Types</router-link>

docs/builtin/breakpoint.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ The `breakpoint()` function in Python, introduced in Python 3.7, provides an eas
4242
# (Pdb)
4343
```
4444

45-
## See Also
45+
## Relevant links
4646

47-
- <router-link :to="'/modules/pdb'">pdb module</router-link>
47+
- <router-link :to="'/cheatsheet/debugging'">Debugging</router-link>
48+
- <router-link :to="'/builtin/print'">print()</router-link>
49+
- <router-link :to="'/cheatsheet/control-flow'">Control Flow</router-link>

docs/builtin/bytearray.md

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

43-
## See Also
43+
## Relevant links
4444

4545
- <router-link :to="'/builtin/bytes'">bytes()</router-link>
46-
- <router-link :to="'/builtin/memoryview'">memoryview()</router-link>
46+
- <router-link :to="'/builtin/memoryview'">memoryview()</router-link>
47+
- <router-link :to="'/cheatsheet/reading-and-writing-files'">Reading and Writing Files</router-link>
48+
- <router-link :to="'/blog/python-data-types'">Python Data Types</router-link>

0 commit comments

Comments
 (0)