xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-05 05:10:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

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
1 changed files with 2 additions and 2 deletions
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] [pr_code_suggestions]
extra_instructions="""\ extra_instructions="""\
(1) Answer in japanese (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 (3) Ignore changes in toml files
... ...
""" """
@ -131,7 +131,7 @@ best practice`.
Example for a python `best_practices.md` content can: Example for a python `best_practices.md` content can:
```markdown ```markdown
## Project best practices ## 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 the `logging` module for logging instead of `print` statements
- Use `is` and `is not` to compare with `None` - Use `is` and `is not` to compare with `None`
- Use `if __name__ == '__main__':` to run the code only when the script is executed - Use `if __name__ == '__main__':` to run the code only when the script is executed