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

mkAliasOptionModule descriptions are not shown in the manual #3543

Closed
2 tasks done
bfcns opened this issue Dec 30, 2022 · 4 comments
Closed
2 tasks done

mkAliasOptionModule descriptions are not shown in the manual #3543

bfcns opened this issue Dec 30, 2022 · 4 comments
Assignees

Comments

@bfcns
Copy link

bfcns commented Dec 30, 2022

Are you following the right branch?

  • My Nixpkgs and Home Manager versions are in sync

Is there an existing issue for this?

  • I have searched the existing issues

Issue description

xsession.pointerCursor options definitions needs to be corrected at https://rycee.gitlab.io/home-manager/options.html.

Maintainer CC

No response

System information

Not important.
@bfcns bfcns added bug triage Issues or feature request that have not been triaged yet labels Dec 30, 2022
@ncfavier
Copy link
Member

They're aliases to the new home.pointerCursor options.

The underlying issue here is that nmd does not support Markdown descriptions, which are used by mkAliasOptionModule and friends.

@ncfavier ncfavier changed the title revision: xsession.pointerCursor options definitions needs to be corrected. mkAliasOptionModule descriptions are not shown in the manual Dec 30, 2022
@ncfavier ncfavier added documentation and removed triage Issues or feature request that have not been triaged yet bug labels Dec 30, 2022
@rycee
Copy link
Member

rycee commented Dec 30, 2022

In this case I think these options need visible = false to make them not show up in the manual at all.

@ncfavier
Copy link
Member

Beware the difference between mkRenamedOptionModule and mkAliasOptionModule: the former have visible = false while the latter have a helpful description. Maybe we just want to use mkRenamedOptionModule everywhere?

@ncfavier
Copy link
Member

Fixed by #3570

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

No branches or pull requests

5 participants