From 73cc7c2d719800fe655bc63f17142869783b46cf Mon Sep 17 00:00:00 2001 From: mrT23 Date: Fri, 29 Sep 2023 11:53:39 +0300 Subject: [PATCH] typos --- README.md | 2 +- Usage.md | 2 +- docs/DESCRIBE.md | 5 +++-- docs/REVIEW.md | 4 ++-- docs/SIMILAR_ISSUE.md | 2 +- docs/TOOLS_GUIDE.md | 4 +++- docs/UPDATE_CHANGELOG.md | 2 +- 7 files changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1edf1072..5f886e87 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ See the [Usage Guide](./Usage.md) for instructions how to run the different tool See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the different tools. -[Release notes](./RELEASE_NOTES.md) +See the [Release notes](./RELEASE_NOTES.md) for updates on the latest changes.

Example results:

diff --git a/Usage.md b/Usage.md index 71991f15..d47a0f53 100644 --- a/Usage.md +++ b/Usage.md @@ -15,7 +15,7 @@ There are 3 basic ways to invoke CodiumAI PR-Agent: 2. Online usage - by [commenting](https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695021901) on a PR 3. Enabling PR-Agent tools to run automatically when a new PR is opened -See the [installation guide](/INSTALL.md) for instructions on how to setup your own PR-Agent. +See the **[installation guide]**(/INSTALL.md) for instructions on how to setup your own PR-Agent. Specifically, CLI commands can be issued by invoking a pre-built [docker image](/INSTALL.md#running-from-source), or by invoking a [locally cloned repo](INSTALL.md#method-2-run-from-source). diff --git a/docs/DESCRIBE.md b/docs/DESCRIBE.md index bdab909a..bb07668c 100644 --- a/docs/DESCRIBE.md +++ b/docs/DESCRIBE.md @@ -1,7 +1,7 @@ # Describe Tool The `describe` tool scans the PR code changes, and automatically generates PR description - title, type, summary, code walkthrough and labels. -It can ba invoked manually by commenting on any PR: +It can be invoked manually by commenting on any PR: ``` /describe ``` @@ -29,9 +29,10 @@ Under the section 'pr_description', the [configuration file](./../pr_agent/setti #### Markers template -markers template enable to easily integrate user's content and auto-generated content. +markers enable to easily integrate user's content and auto-generated content, with a template-like mechanism. - `use_description_markers`: if set to true, the tool will use markers template. It replaces every marker of the form `pr_agent:marker_name` with the relevant content. Default is false. + For example, if the PR original description was: ``` User content... diff --git a/docs/REVIEW.md b/docs/REVIEW.md index 92c67196..6312a19c 100644 --- a/docs/REVIEW.md +++ b/docs/REVIEW.md @@ -1,7 +1,7 @@ # Describe Tool The `review` tool scans the PR code changes, and automatically generates a PR review. -It can ba invoked manually by commenting on any PR: +It can be invoked manually by commenting on any PR: ``` /review ``` @@ -31,7 +31,7 @@ By invoking: ``` /reflect_and_review ``` -The module will first ask the author questions about the PR, and will guide the review based on his answers. +The tool will first ask the author questions about the PR, and will guide the review based on his answers. diff --git a/docs/SIMILAR_ISSUE.md b/docs/SIMILAR_ISSUE.md index ac7f0157..695ef459 100644 --- a/docs/SIMILAR_ISSUE.md +++ b/docs/SIMILAR_ISSUE.md @@ -1,6 +1,6 @@ # Similar Issue Tool The similar issue tool retrieves the most similar issues to the current issue. -It can ba invoked manually by commenting on any PR: +It can be invoked manually by commenting on any PR: ``` /similar_issue ``` diff --git a/docs/TOOLS_GUIDE.md b/docs/TOOLS_GUIDE.md index 758188a5..6b126088 100644 --- a/docs/TOOLS_GUIDE.md +++ b/docs/TOOLS_GUIDE.md @@ -4,4 +4,6 @@ - [IMPROVE](./IMPROVE.md) - [ASK](./ASK.md) - [SIMILAR_ISSUE](./SIMILAR_ISSUE.md) -- [UPDATE CHANGELOG](./UPDATE_CHANGELOG.md) \ No newline at end of file +- [UPDATE CHANGELOG](./UPDATE_CHANGELOG.md) + +See the **[installation guide]**(/INSTALL.md) for instructions on how to setup your own PR-Agent. \ No newline at end of file diff --git a/docs/UPDATE_CHANGELOG.md b/docs/UPDATE_CHANGELOG.md index 30091be6..3491feeb 100644 --- a/docs/UPDATE_CHANGELOG.md +++ b/docs/UPDATE_CHANGELOG.md @@ -15,5 +15,5 @@ For example: Under the section 'pr_update_changelog', the [configuration file](./../pr_agent/settings/configuration.toml#L50) contains options to customize the 'update changelog' tool: -- `push_changelog_changes`: whether to push the changes to changelog changes, or just print them. Default is false (print only). +- `push_changelog_changes`: whether to push the changes to CHANGELOG.md, or just print them. Default is false (print only). - `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ... \ No newline at end of file