Skip to content

Commit 03cef74

Browse files
committed
Further nitpick cleanup.
1 parent cbd18c9 commit 03cef74

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

Diff for: docs/getting-started/quickstart.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -96,33 +96,33 @@ After CodeRabbit reviews a pull request, you can converse with it about its revi
9696

9797
1. Post the following as a new GitHub comment attached to the pull request:
9898

99-
```
100-
@coderabbitai Why do all of these functions need docstrings? Isn't it obvious enough what they do?
101-
```
99+
```text
100+
@coderabbitai Why do all of these functions need docstrings? Isn't it obvious enough what they do?
101+
```
102102

103-
After a few moments, CodeRabbit posts its reply, explaining its motivations for its recommendation. The reply might resemble the following:
103+
After a few moments, CodeRabbit posts its reply, explaining its motivations for its recommendation. The reply might resemble the following:
104104

105-
> You're right that these functions are quite self-explanatory from their names alone. Docstrings aren't strictly necessary for every function, especially in smaller projects with clear function names.
106-
>
107-
> While docstrings do provide benefits (IDE tooltips, documentation generation, help for future developers), they can sometimes feel redundant for very straightforward functions. It's ultimately a matter of coding style and project requirements.
108-
>
109-
> If you prefer to skip docstrings for obvious utility functions in 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 necessary for every function, especially in smaller projects with clear function names.
106+
>
107+
> While docstrings do provide benefits (IDE tooltips, documentation generation, help for future developers), they can sometimes feel redundant for very straightforward functions. It's ultimately a matter of coding style and project requirements.
108+
>
109+
> If you prefer to skip docstrings for obvious utility functions in this project, that's perfectly reasonable. Would you like me to adjust my review approach regarding documentation for this repository?
110110

111-
In this case, CodeRabbit is offering to adjust its future behavior when reviewing changes to this repository. Instead, follow the next step to ask CodeRabbit to implement part of its suggestions.
111+
In this case, CodeRabbit is offering to adjust its future behavior when reviewing changes to this repository. Instead, follow the next step to ask CodeRabbit to implement part of its suggestions.
112112

113113
1. Post the following as another new comment:
114114

115-
```
116-
@coderabbitai generate docstrings
117-
```
115+
```text
116+
@coderabbitai generate docstrings
117+
```
118118

119-
After a few moments, CodeRabbit does the following:
119+
After a few moments, CodeRabbit does the following:
120120

121-
* CodeRabbit creates a new branch, based on `add-utils`.
121+
* CodeRabbit creates a new branch, based on `add-utils`.
122122

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`.
124124

125-
* CodeRabbit opens a new pull request between the new branch and `add-utils`.
125+
* CodeRabbit opens a new pull request between the new branch and `add-utils`.
126126

127127
## Clean up
128128

0 commit comments

Comments
 (0)