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

Fix header for generated Dhall documentation #109337

Merged
merged 1 commit into from Jan 14, 2021
Merged

Fix header for generated Dhall documentation #109337

merged 1 commit into from Jan 14, 2021

Conversation

Gabriella439
Copy link
Contributor

By default, dhall-docs uses the name of the input directory
as the initial component of the documentation header. However,
since the input directory is built using Nix the header contains
the Nix store hash in the name, which then appears in the
generated documentation.

The fix is to override this default behavior by supplying the
--package-name flag to dhall-docs.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • 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 nixpkgs-review --run "nixpkgs-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.

@Gabriella439
Fix header for generated Dhall documentation
41c31b9 
By default, `dhall-docs` uses the name of the input directory
as the initial component of the documentation header.  However,
since the input directory is built using Nix the header contains
the Nix store hash in the name, which then appears in the
generated documentation.

The fix is to override this default behavior by supplying the
`--package-name` flag to `dhall-docs`.
@Gabriella439
Copy link
Contributor Author

cc: @ehmry

@Gabriella439
Copy link
Contributor Author

Here's an example of what the documentation looks like before the fix:

Screenshot_20210113_195638

… and here is what it looks like after the fix:

Screenshot_20210113_200244

cole-h
cole-h approved these changes Jan 14, 2021
View reviewed changes
Copy link
Member

@cole-h cole-h left a comment

Choose a reason for hiding this comment

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

Definitely looks nicer; diff LGTM.

@ehmry ehmry merged commit 710038a into NixOS:master Jan 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cole-h cole-h cole-h approved these changes

@Profpatsch Profpatsch Awaiting requested review from Profpatsch Profpatsch is a code owner

Assignees
No one assigned
Labels
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
3 participants
@Gabriella439 @cole-h @ehmry