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.

Sign up for GitHub

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

Jump to bottom

acpid: fix escaping in handlers doc example #66484

Closed
wants to merge 1 commit into from
Closed

acpid: fix escaping in handlers doc example #66484

wants to merge 1 commit into from

Conversation

turboMaCk
Copy link
Member

Current documentation for acpid on the web is a bit confusing as the '' escape sequence is not visible. I think this PR should resolve this.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nix-review --run "nix-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

@mmahut
Copy link
Member

mmahut commented Aug 19, 2019

Thank you, how did you test it?

@turboMaCk
Copy link
Member Author

turboMaCk commented Aug 20, 2019 •
edited

@mmahut I haven't tested it so it's sort of guessing game that this type of escaping will result in having all important symbols readable in docs. Is there any way to test the documentation rendering?

@mmahut mmahut self-assigned this Aug 20, 2019
@mmahut
Copy link
Member

mmahut commented Aug 22, 2019

I did not find a way, but I guess it will be related to https://github.com/NixOS/nixos-homepage/.

Maybe @samueldr knows?

@turboMaCk
Copy link
Member Author

let me know if I should close this. The reaon why I opened it was that the documentation was confusing and I spent quite some time finding a way how to escape it correctly. Anyway this is nice to have and if it's hard to confirm that this would improve the situation it might not be worh it.

@turboMaCk
Copy link
Member Author

closing due to long inactivity

@turboMaCk turboMaCk closed this Oct 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@mmahut mmahut

Labels
6.topic: nixos 8.has: module (update) 10.rebuild-darwin: 0 10.rebuild-linux: 0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@turboMaCk @mmahut