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 typo in xdg-user-dirs. #987

Closed
wants to merge 1 commit into from
Closed

Fix typo in xdg-user-dirs. #987

wants to merge 1 commit into from

Conversation

mtreca
Copy link

@mtreca mtreca commented Jan 13, 2020

Configuration key publishShare has been replaced by publicShare.

See #985

Copy link
Contributor

@vojta001 vojta001 left a comment

Choose a reason for hiding this comment

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

Don't you have to change it on line 93 as well?

@mtreca
Copy link
Author

mtreca commented Jan 13, 2020

@vojta001 You are correct. Fixed.

@teto
Copy link
Collaborator

teto commented Jan 14, 2020

this may break configs, not sure if we can alias the option or if it's worth it.

@mtreca
Copy link
Author

mtreca commented Jan 15, 2020

@teto Is breaking config for incorrect configuration keys such a bad thing?
I am genuinely asking since I am quite new to the project.

I know I had to triple check when first setting up my XDG config since the typo is easily overlooked. so that's a cost for users as well.

@teto
Copy link
Collaborator

teto commented Jan 15, 2020

I think thats fine considering its a relatively new module but I prefer to wait for @rycee s approval

@rycee
Copy link
Member

rycee commented Jan 15, 2020

Thanks for the discovery and fix! I would suggest adding

imports = [
  (mkRenamedOptionModule
    [ "xdg" "userDirs" "publishShare" ]
    [ "xdg" "userDirs" "publicShare" ])
];

to the module, under the meta.maintainers line.

Then configurations using the old name will still work but a warning will be printed saying the name has changed. We can remove this mkRenamedOptionModule thing in the next release cycle.

@rycee
Copy link
Member

rycee commented Jan 15, 2020

Oh, also. The commit description should be changed to match the guidelines. Something like

xdg-user-dirs: fix typo in option name

Fixes #985

should be fine.

@mtreca
Copy link
Author

mtreca commented Jan 16, 2020

@rycee Thank you for the feedback. I changed the commit message and added your suggestion.

rycee pushed a commit that referenced this pull request Jan 17, 2020
@rycee
Copy link
Member

rycee commented Jan 17, 2020

Thanks! Rebased to master in c8323a0.

@rycee rycee closed this Jan 17, 2020
jorsn pushed a commit to jorsn/home-manager that referenced this pull request Apr 25, 2020
teto pushed a commit to teto/home-manager that referenced this pull request Jun 29, 2020
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.

4 participants