You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 16, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: docs/getting-started/quickstart.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -96,33 +96,33 @@ After CodeRabbit reviews a pull request, you can converse with it about its revi
96
96
97
97
1. Post the followingas a new GitHub comment attached to the pull request:
98
98
99
-
```
100
-
@coderabbitai Why doall of these functions need docstrings? Isn't it obvious enough what they do?
101
-
```
99
+
```text
100
+
@coderabbitai Why doall of these functions need docstrings? Isn't it obvious enough what they do?
101
+
```
102
102
103
-
After a few moments, CodeRabbit posts its reply, explaining its motivationsfor its recommendation. The reply might resemble the following:
103
+
After a few moments, CodeRabbit posts its reply, explaining its motivationsfor its recommendation. The reply might resemble the following:
104
104
105
-
> You're right that these functions are quite self-explanatory from their names alone. Docstrings aren't strictly necessaryfor every function, especiallyin smaller projectswith clear function names.
106
-
>
107
-
> While docstrings do provide benefits (IDE tooltips, documentation generation,helpfor future developers), they can sometimes feel redundantfor very straightforward functions. It's ultimately a matter of coding style and project requirements.
108
-
>
109
-
> If you prefer to skip docstringsfor obvious utility functionsin this project, that's perfectly reasonable. Would you like me to adjust my review approach regarding documentation for this repository?
105
+
> You're right that these functions are quite self-explanatory from their names alone. Docstrings aren't strictly necessaryfor every function, especiallyin smaller projectswith clear function names.
106
+
>
107
+
> While docstrings do provide benefits (IDE tooltips, documentation generation,helpfor future developers), they can sometimes feel redundantfor very straightforward functions. It's ultimately a matter of coding style and project requirements.
108
+
>
109
+
> If you prefer to skip docstringsfor obvious utility functionsin this project, that's perfectly reasonable. Would you like me to adjust my review approach regarding documentation for this repository?
110
110
111
-
In this case, CodeRabbitis offering to adjust its future behavior when reviewing changes to this repository. Instead, follow thenext step to ask CodeRabbit to implement part of its suggestions.
111
+
In this case, CodeRabbitis offering to adjust its future behavior when reviewing changes to this repository. Instead, follow thenext step to ask CodeRabbit to implement part of its suggestions.
112
112
113
113
1. Post the followingas another new comment:
114
114
115
-
```
116
-
@coderabbitai generate docstrings
117
-
```
115
+
```text
116
+
@coderabbitai generate docstrings
117
+
```
118
118
119
-
After a few moments, CodeRabbit does the following:
119
+
After a few moments, CodeRabbit does the following:
120
120
121
-
* CodeRabbit creates a new branch, based on`add-utils`.
121
+
* CodeRabbit creates a new branch, based on`add-utils`.
122
122
123
-
* CodeRabbit commits changes to the branch that adds suggested docstrings to`add-utils`.
123
+
* CodeRabbit commits changes to the branch that adds suggested docstrings to`add-utils`.
124
124
125
-
* CodeRabbit opens a new pull request between the new branchand`add-utils`.
125
+
* CodeRabbit opens a new pull request between the new branchand`add-utils`.