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 opening comment in spago.dhall to refer back to Spago's Readme #708

Closed
JordanMartinez opened this issue Dec 9, 2020 · 5 comments · Fixed by #778
Closed

Update opening comment in spago.dhall to refer back to Spago's Readme #708

JordanMartinez opened this issue Dec 9, 2020 · 5 comments · Fixed by #778

Comments

@JordanMartinez
Copy link
Contributor

The spago.dhall file has this comment added automatically:

{-
Welcome to a Spago project!
You can edit this file as you like.
-}

Should this comment be removed by default? It doesn't add anything besides notifying someone unfamiliar with spago and package sets in general that it's a Spago-related item. However, I feel like Spago has become more of the norm now that even that reason isn't much of a reason now.

@hdgarrood
Copy link
Contributor

hdgarrood commented Dec 9, 2020

I'm not particularly keen on this: it doesn't matter how many of the existing users know what this file is for, we should still design for users who are picking up the tool for the first time.

@JordanMartinez
Copy link
Contributor Author

True, but could it be updated to say something more meaningful than its current comments? At the very least, it could link to the spago readme so a user can read more of its documentation.

@hdgarrood
Copy link
Contributor

That sounds sensible to me, yes.

@f-f
Copy link
Member

f-f commented Dec 9, 2020

Yes, I agree with both of you - I'd like to keep the comment there in order to ensure a good first experience, but I'd also welcome a rework that makes it more substantial/useful (it might be useful to also point out that there's a flag if a user wishes to skip it for future projects)

@JordanMartinez JordanMartinez changed the title Remove opening comment in spago.dhall by default? Update opening comment in spago.dhall to refer back to Spago's Readme Dec 9, 2020
@JordanMartinez
Copy link
Contributor Author

it might be useful to also point out that there's a flag if a user wishes to skip it for future projects)

Yeah, but I forgot to include that flag when I was updating some libraries 😅

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

Successfully merging a pull request may close this issue.

3 participants