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

Model workflow: pass --disable-documentation to cabal haddock #109

Merged
merged 3 commits into from
Jan 13, 2025

Conversation

andreasabel
Copy link
Member

@andreasabel andreasabel commented Jan 8, 2025

Closes #107.

Asking @bmillwood for a review.

bmillwood added a commit to bmillwood/bluesky-tools that referenced this pull request Jan 8, 2025
For the sake of haskell-actions/setup#109
Copy link
Contributor

@mihaimaruseac mihaimaruseac left a comment

Choose a reason for hiding this comment

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

(non-binding, but this looks good to me, based on the discussion in the issue)

Copy link

@bmillwood bmillwood left a comment

Choose a reason for hiding this comment

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

README.md Outdated
```
(Alternatively, the two occurrences of `--disable-documentation` can be changed to `--enable-documentation`, for resolving the external references in the haddockumentation.)
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm afraid "haddockumentation" may be confusing. Gave me a second for sure.

Maybe it can also mention something about possible slowdown due to having to build docs for dependencies.

Copy link
Contributor

Choose a reason for hiding this comment

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

I also think parentheses should be dropped (it's too long of a thing to put it into those).

@andreasabel
Copy link
Member Author

@bmillwood and @ulysses4ever , thanks for your reviews!
I tried to address both of your suggestions in the latest commit.

@andreasabel andreasabel added the pr: squash PR should be squashed upon merge label Jan 13, 2025
@ulysses4ever
Copy link
Contributor

Looks good, thanks!

@bmillwood
Copy link

Looks good to me too. Suggested a typo fix but happy either way.

@andreasabel andreasabel merged commit cbf8b7a into main Jan 13, 2025
@andreasabel andreasabel deleted the README-disable-documentation branch January 13, 2025 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr: squash PR should be squashed upon merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

how come the README example configures with --disable-documentation?
4 participants