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

Rename EarmarkParser to Earmark.Parser to avoid conflicts #470

Merged
merged 1 commit into from
Sep 26, 2023
Merged

Rename EarmarkParser to Earmark.Parser to avoid conflicts #470

merged 1 commit into from
Sep 26, 2023

Conversation

josevalim
Copy link
Contributor

Otherwise, if a project depends on both earmark_parser and
earmark at the same time, the module will conflict with each
other.

@josevalim
Copy link
Contributor Author

Hi @RobertDober, I am aware you are looking for maintainers but if you could include this change and do a new release, it would be very much welcome and appreciated.

Thank you very much for your time! ❤️

@RobertDober
Copy link
Collaborator

Now I am confused, I did not do this already?
Well, obviously not, that's why we need a new maintainer, but of course I will do stuff like this as long as I can find some minutes a day ;)

So it is I who thanx you as a matter of fact

@RobertDober RobertDober merged commit 7fed587 into pragdave:master Sep 26, 2023
3 checks passed
@@ -1,25 +1,25 @@
defmodule Earmark.EarmarkParserProxy do
defmodule Earmark.Earmark.ParserProxy do

Choose a reason for hiding this comment

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

I couldn't help but notice, shouldn't this be Earmark.ParserProxy (without the double Earmark)? @josevalim
(Sorry if I'm off, I'm not familiar with the project)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, good find. I can submit a PR. :) Although perhaps this module can be removed too. :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Or perhaps, since it is publicly documented, we should not change its name.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I just merged it I did not understand why. I will be little available in the next days, shall I ask Dave to give you or some proxy of you (pun intended) commit rights here and also publish rights to hex.

I will merge and publish as much as I can, but maybe it would be good to have fallback options.

Again thank you for helping out.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@RobertDober there is no "technical" reason for the change, except that the module was publicly documented before, so it is best to not change its name in a patch version. :)

Regarding the package on Hex, there is no need to worry. If someday you decide to go on a well-deserved holidays/sabbatical/retirement and not touch a computer for several months, Hex has mechanisms in place to inherit a package after some time.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Thank you for that explanation.

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.

3 participants