Skip to contents

Print method for pr_create_result objects

Source: R/pr.R
print.pr_create_result.Rd

This method provides a formatted summary of pull request creation results, showing counts by status and details for created PRs and any errors encountered.

Usage

# S3 method for class 'pr_create_result'
print(x, ...)

Arguments

x

An object of class "pr_create_result" as returned by pr_create()

...

Additional arguments passed to other print methods (not used)

Value

Invisibly returns the original input data frame (x) unchanged, allowing for chained operations. The function's primary purpose is displaying a formatted summary to the console, including:

  • Counts of PRs by status (created, would_create, skipped, error)

  • List of successfully created PRs with clickable URLs

  • Details about any errors encountered during the process

Examples

if (FALSE) { # interactive()
# Create PRs
results <- pr_create(
  repos = repos("my-organization"),
  branch_name = "feature-branch",
  title = "Update configuration",
  body = "Standardize configuration across repos",
  file_mapping = file_mapping("config.yml" = ".github/config.yml")
)

print(results)  # Explicitly print the summary
}