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 README snippet for adding registry #83

Closed
wants to merge 1 commit into from

Conversation

Socob
Copy link

@Socob Socob commented Feb 8, 2024

Just a small fix for the snippet showing how to add a registry using Pkg in README.md.

@GunnarFarneback
Copy link
Owner

Thanks for pointing out the mistake. I find the full syntax too annoying though so I'll just revert that part of #82.

@@ -43,8 +43,9 @@ The recommended way to create a registry is
using LocalRegistry
create_registry(name, repository_url; description = "My private registry", push = true)
```
where `name` is the name of your registry and `repository_url` points
to an *empty* upstream repository where you will host your registry.
where `name` is the name of your registry as a `String` and
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What alternative is there to using a String?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe that was just because I was confused because the other example didn’t work, but it wasn’t entirely clear to me what these variables were supposed to be. E. g. repository_url could be a RegistrySpec, or some special URL type.

@Socob Socob deleted the doc-add-registry branch February 8, 2024 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants