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

Add clearer docs for Prelude module #270

Merged
merged 2 commits into from
Sep 19, 2021
Merged

Add clearer docs for Prelude module #270

merged 2 commits into from
Sep 19, 2021

Conversation

JordanMartinez
Copy link
Contributor

Description of the change

Fixes #251


Checklist:

  • Added the change to the changelog's "Unreleased" section with a reference to this PR (e.g. "- Made a change (#0000)")
  • Linked any existing issues or proposals that this pull request should close
  • Updated or added relevant documentation
  • Added a test for the contribution (if applicable)

-- |
-- | import Prelude -- open import
-- |
-- | import Data.Maybe (Maybe(..)) -- closed import
Copy link
Member

Choose a reason for hiding this comment

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

I’m not sure we need to describe this as a closed import, or comment next to the Prelude import as an open one, but I don’t feel too strongly about it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If the 'open import' comment confuses people, we can see how to edit this later. For now, I think it does more good than harm.

@JordanMartinez JordanMartinez merged commit 6ddee1b into master Sep 19, 2021
@JordanMartinez JordanMartinez deleted the addPreludeDocs branch September 19, 2021 15:03
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.

Add high-level documentation
2 participants