ti.sil/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-12-12 02:45:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: fix typos in improve.md documentation

Browse source
This commit is contained in:
mrT23 2024-12-09 09:04:53 +02:00
parent 9e25667d97
commit c45cde93ef
No known key found for this signature in database
GPG key ID: D350490E39D5F5AD
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/docs/tools/improve.md
View file

@ -111,7 +111,7 @@ Examples for possible instructions:
[pr_code_suggestions]
extra_instructions="""\
(1) Answer in japanese
(2) Don't suggest to add try-excpet block
(2) Don't suggest to add try-except block
(3) Ignore changes in toml files
...
"""
@ -131,7 +131,7 @@ best practice`.
Example for a python `best_practices.md` content can:
```markdown
## Project best practices
- Make sure that I/O operation are encapsulated in a try-except block
- Make sure that I/O operations are encapsulated in a try-except block
- Use the `logging` module for logging instead of `print` statements
- Use `is` and `is not` to compare with `None`
- Use `if __name__ == '__main__':` to run the code only when the script is executed