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

Update README for new project-file key #403

Merged
merged 2 commits into from
Jun 16, 2023

Conversation

fendor
Copy link
Collaborator

@fendor fendor commented May 11, 2023

No description provided.

```yaml
cradle:
cabal:
project-file: "./cabal.project.dev"
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I just noticed that there is a naming scheme inconsistency, namely project-file vs stackYaml. We should be consistent, but what would be the better name than project-file? projectFile looks kind of bad.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

In consistency with stackYaml, maybe cabalProject?

Copy link
Contributor

Choose a reason for hiding this comment

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

cabalProject sounds reasonable to me.

README.md Outdated Show resolved Hide resolved
Co-authored-by: Michael Peyton Jones <me@michaelpj.com>
@fendor
Copy link
Collaborator Author

fendor commented Jun 12, 2023

For now, I am merging the PR as is, renaming project-file to cabalProject in a subsequent PR, to keep the separation of Documentation updates and hie.yaml updates.

@fendor fendor merged commit 3d4fadf into haskell:master Jun 16, 2023
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.

2 participants