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

Haddock document the case functions, so that their behavior is easier to understand when calling them #314

Merged
merged 1 commit into from Oct 12, 2023

Conversation

smelc
Copy link
Contributor

@smelc smelc commented Oct 12, 2023

Changelog

- description: |
    Haddock-document the `case*` functions
# uncomment types applicable to the change:
  type:
  # - feature        # introduces a new feature
  # - breaking       # the API has changed in a breaking way
  - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  - improvement    # QoL changes e.g. refactoring
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  # - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...

Context

Haddock-document the case* functions, because I've had trouble parsing them and I think English helps here (despite the functions being kind of "mechanical")

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • The change log section in the PR description has been filled in
  • NA New tests are added if needed and existing tests are updated. These may include:
    • golden tests
    • property tests
    • round trip tests
    • integration tests
      See Running tests for more details
  • NA The version bounds in .cabal files are updated
  • CI passes. See note on CI. The following CI checks are required:
    • Code is linted with hlint. See .github/workflows/check-hlint.yml to get the hlint version
    • Code is formatted with stylish-haskell. See .github/workflows/stylish-haskell.yml to get the stylish-haskell version
    • Code builds on Linux, MacOS and Windows for ghc-8.10.7 and ghc-9.2.7
  • Self-reviewed the diff

@smelc
Copy link
Contributor Author

smelc commented Oct 12, 2023

cc @newhoggy

@smelc smelc enabled auto-merge October 12, 2023 14:04
@smelc smelc added the documentation Improvements or additions to documentation label Oct 12, 2023
@smelc smelc force-pushed the smelc/document-case-functions branch from 46ccc66 to 89140c8 Compare October 12, 2023 15:50
@smelc smelc added this pull request to the merge queue Oct 12, 2023
Merged via the queue into main with commit 7e54356 Oct 12, 2023
22 checks passed
@smelc smelc deleted the smelc/document-case-functions branch October 12, 2023 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants