Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): update parameter name #16933

Closed
wants to merge 1 commit into from
Closed

Conversation

apogiatzis
Copy link

Minor update of the documentation when creating a GithubRepository block.

Checklist

  • This pull request references any related issue by including "closes <link to issue>"
    • If no issue exists and your change is not a small fix, please create an issue first.
  • If this pull request adds new functionality, it includes unit tests that cover the changes
  • If this pull request removes docs files, it includes redirect settings in mint.json.
  • If this pull request adds functions or classes, it includes helpful docstrings.

@zzstoatzz
Copy link
Collaborator

hi @apogiatzis - thanks for the PR, but this is not correct - GitRepository is not the same as the GitHubRepository block defined in prefect-github. The correct parameter here is url, see https://github.com/prefecthq/prefect/blob/main/src/prefect/runner/storage.py#L83-L117

@zzstoatzz zzstoatzz closed this Feb 3, 2025
@apogiatzis
Copy link
Author

Ah you are right! Apologies, I could have sworn that I'd copied the code from documentation and I encountered the parameter mismatch while testing but I guess I must have changed it to GithubRepository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants