Sourcery Code Review¶
Sourcery can give you an on demand review of the changes you've made to your code.
Available Review Options¶
The available review options depend on whether you have a Git project open in your editor. If you do, you have the following options:
- Compare current working tree with default branch
This will give you a review of a comparison between the current working tree and the default branch (usually main
or master
).
- Compare uncommitted changes with HEAD
This will give you a review of a comparison between the uncommitted changes and the current HEAD.
You also always have this option available:
- Review the current file
This will give you a review of the current file.
Review¶
Once you request a review, you will get an instant summary of the changes, or the current file. In the background, Sourcery will then generate a review for you, consisting of: - Diagrams illustrating the code, or the changes. - An overall comment on the changes and any issues that were found. - A list of comments on individual lines of code, which will often include suggestions for fixing them.