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

Add a note about the rename in the 1.1 documentation #54

Open
japhib opened this issue Jun 15, 2021 · 2 comments
Open

Add a note about the rename in the 1.1 documentation #54

japhib opened this issue Jun 15, 2021 · 2 comments

Comments

@japhib
Copy link

japhib commented Jun 15, 2021

It's unclear to new (or old) users that the library has been renamed to elixir_uuid. If you just google "elixir uuid", this page comes up as the first result:

https://hexdocs.pm/uuid/readme.html

which is the link to 1.1.8 of the library, the release just before the rename. On that page there's no indication of the rename, and no indication that there's any version later than 1.1.8.

Would it be possible to add a note to the readme for that version and make a 1.1.9 release so it shows up in hexdocs?

@japhib
Copy link
Author

japhib commented Jun 15, 2021

I made a PR for this: #55 - Note the PR is set to merge into master, but ideally instead it'd just remain a separate branch since we wouldn't want this change to affect v1.2+.

Is this even the right approach? If it gets merged & tagged as v1.1.9, will it still update hexdocs for the older repo? I'm new to contributing on Github, so not sure how that all works.

@hogiyogi597
Copy link

Just ran into this exact issue. Having this in the docs would be extremely helpful as I had not realized that the library had been renamed.

waranlogesh added a commit to hammeraj/onvif that referenced this issue Sep 20, 2023
- Package name of `uuid` has been renamed to `elixir_uuid`. Ref: zyro/elixir-uuid#54.
- This fixes compilation error when this library is used in project with `:elixir_uuid` in deps.
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

No branches or pull requests

2 participants