From 0b22c8d427e715517178942349eea83ceb9b7029 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Sun, 30 Jul 2023 22:04:59 +0300 Subject: [PATCH] update README.md --- CONFIGURATION.md | 2 +- README.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CONFIGURATION.md b/CONFIGURATION.md index 76274caa..fc1f6dab 100644 --- a/CONFIGURATION.md +++ b/CONFIGURATION.md @@ -8,5 +8,5 @@ For example if you want to edit online the `pr_reviewer` configurations, you can /review --pr_reviewer.extra_instructions="focus on the file xyz" --require_score_review=false ... ``` -Any configuration section in `configuration.toml` file can be similarly edited. +Any configuration value in `configuration.toml` file can be similarly edited. diff --git a/README.md b/README.md index b5668a6a..b92de6a0 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review pull **Question Answering**: Answering free-text questions about the PR. \ **Code Suggestion**: Committable code suggestions for improving the PR. - +\ **Update Changelog**: Automatically updating the CHANGELOG.md file with the PR changes.

Example results:

@@ -102,7 +102,7 @@ Examples for invoking the different tools via the CLI: - **Improve**: python cli.py --pr-url= improve - **Ask**: python cli.py --pr-url= ask "Write me a poem about this PR" - **Reflect**: python cli.py --pr-url= reflect -- **Update changelog**: python cli.py --pr-url= update_changelog +- **Update Changelog**: python cli.py --pr-url= update_changelog "" is the url of the relevant PR (for example: https://github.com/Codium-ai/pr-agent/pull/50).