Skip to content

Commit 0d192e4

Browse files
docs: clarify PRPB and PR relationship in README
Co-Authored-By: Patched <[email protected]>
1 parent 6c6f057 commit 0d192e4

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

patchwork/steps/CreatePR/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@
1616
- `run() -> dict`: Method to run the pull request creation process with the following output:
1717
- `pr_url`: URL of the created pull request
1818

19-
This module provides functionality to create a pull request on a source control management platform (Github or Gitlab) based on the input data provided. It includes methods for checking required data, handling platform-specific API keys, setting up the pull request parameters, and executing the pull request creation process. The `create_pr` method within the module helps in finding or creating a pull request with necessary details and descriptions, including the ability to link PRs to GitHub issues. The module also logs information throughout the process for tracking and verification purposes.
19+
This module provides functionality to create a pull request on a source control management platform (Github or Gitlab) based on the input data provided. It includes methods for checking required data, handling platform-specific API keys, setting up the pull request parameters, and executing the pull request creation process. The `create_pr` method within the module helps in finding or creating a pull request with necessary details and descriptions, including the ability to link PRs to GitHub issues. The module also logs information throughout the process for tracking and verification purposes. This module is used by both PR and PRPB (Pull Request Patch Builder) steps, where PRPB is an alias for PR defined in `patchwork/steps/__init__.py`.

0 commit comments

Comments
 (0)