Skip to content

Commit 112400e

Browse files
committed
Running through prettier to make Travis happy.
1 parent 2cd1783 commit 112400e

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

docs/getting-started/quickstart.md

+35-35
Original file line numberDiff line numberDiff line change
@@ -58,29 +58,29 @@ Use your usual Git workflow to perform the following steps in the `coderabbit-te
5858

5959
1. In that new `add-utils` branch, create a new file called `simple_utils.py`, with the following content:
6060

61-
```python
62-
# simple_utils.py - A tiny utility library
61+
```python
62+
# simple_utils.py - A tiny utility library
6363

64-
def reverse_string(text):
65-
"""Reverses the characters in a string."""
66-
return text[::-1]
64+
def reverse_string(text):
65+
"""Reverses the characters in a string."""
66+
return text[::-1]
6767

68-
def count_words(sentence):
69-
return len(sentence.split())
68+
def count_words(sentence):
69+
return len(sentence.split())
7070

71-
def celsius_to_fahrenheit(celsius):
72-
return (celsius * 9/5) + 32
73-
```
71+
def celsius_to_fahrenheit(celsius):
72+
return (celsius * 9/5) + 32
73+
```
7474

7575
1. Commit the added file to the `add-utils` branch. Use any text you want for the commit message.
7676

7777
1. Create a pull request that proposes to merge the `add-utils` branch into the `main` branch. Use any text you want for the pull request message.
7878

7979
After a few moments, CodeRabbit responds to the pull request using the `@coderabbitai` GitHub account. It performs the following actions, all of which are visible on the pull request's page on GitHub:
8080

81-
* If you didn't write a pull request summary, then CodeRabbit adds a new summary to the pull request.
82-
* CodeRabbit posts a comment titled **Walkthrough** containing analysis and commentary about the content of the pull request.
83-
* CodeRabbit attaches a detailed code review to the pull request as another comment.
81+
- If you didn't write a pull request summary, then CodeRabbit adds a new summary to the pull request.
82+
- CodeRabbit posts a comment titled **Walkthrough** containing analysis and commentary about the content of the pull request.
83+
- CodeRabbit attaches a detailed code review to the pull request as another comment.
8484

8585
Part of the review resembles the following screenshot:
8686

@@ -94,31 +94,31 @@ After CodeRabbit reviews a pull request, you can converse with it about its revi
9494

9595
1. Post the following as a new GitHub comment attached to the pull request:
9696

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

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

103-
> 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.
104-
>
105-
> 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.
106-
>
107-
> 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?
103+
> 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.
104+
>
105+
> 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.
106+
>
107+
> 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?
108108
109-
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.
109+
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.
110110

111111
1. Post the following as another new comment:
112112

113-
```text
114-
@coderabbitai generate docstrings
115-
```
113+
```text
114+
@coderabbitai generate docstrings
115+
```
116116

117-
After a few moments, CodeRabbit does the following:
117+
After a few moments, CodeRabbit does the following:
118118

119-
* CodeRabbit creates a new branch, based on `add-utils`.
120-
* CodeRabbit commits changes to the branch that adds suggested docstrings to `add-utils`.
121-
* CodeRabbit opens a new pull request between the new branch and `add-utils`.
119+
- CodeRabbit creates a new branch, based on `add-utils`.
120+
- CodeRabbit commits changes to the branch that adds suggested docstrings to `add-utils`.
121+
- CodeRabbit opens a new pull request between the new branch and `add-utils`.
122122

123123
## Clean up
124124

@@ -128,8 +128,8 @@ You are now ready to add CodeRabbit to other repositories that you own, and let
128128

129129
## What's next
130130

131-
* [Integrate CodeRabbit](/platforms/) with your repositories on GitHub, GitLab, Azure DevOps, or Bitbucket.
132-
* [Configure CodeRabbit](/getting-started/configure-coderabbit) beyond its default settings.
133-
* [Add custom review instructions](/guides/review-instructions).
134-
* [Get support for CodeRabbit](/getting-started/support).
135-
* [Learn more about how CodeRabbit works](/overview/why-coderabbit).
131+
- [Integrate CodeRabbit](/platforms/) with your repositories on GitHub, GitLab, Azure DevOps, or Bitbucket.
132+
- [Configure CodeRabbit](/getting-started/configure-coderabbit) beyond its default settings.
133+
- [Add custom review instructions](/guides/review-instructions).
134+
- [Get support for CodeRabbit](/getting-started/support).
135+
- [Learn more about how CodeRabbit works](/overview/why-coderabbit).

0 commit comments

Comments
 (0)