Fix variable naming conflicts in doctests and documentation accuracy#41
Merged
akollegger merged 2 commits intorefactor/rename-pattern-constructorsfrom Dec 30, 2025
Merged
Conversation
Co-authored-by: akollegger <53756+akollegger@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update Pattern library documentation for constructor changes
Fix variable naming conflicts in doctests and documentation accuracy
Dec 30, 2025
akollegger
approved these changes
Dec 30, 2025
4fa37d8
into
refactor/rename-pattern-constructors
1 check passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses review comments from PR #40 regarding variable naming conflicts in doctest examples and documentation inconsistencies.
Changes
Documentation: Corrected
pattern-construction.mdto state "two functionally equivalent ways" (was "three") for creating atomic patterns, reflecting that onlypointandpureremain afterpatternWithremoval.Doctest variable naming: Renamed all variables named
patterntopinPattern.Core.hsto avoid shadowing thepatternfunction. Affects Functor and Traversable instance examples.✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.
Note
Documentation cleanup and doctest fixes
docs/users/api/pattern-construction.mdto reflect only two atomic constructors (point,pure) and clarifies thatpatternis for patterns with elementspatterntopinPattern/Core.hsFunctor and Traversable examples to avoid shadowing thepatternfunction; no functional code changesWritten by Cursor Bugbot for commit 4966c95. This will update automatically on new commits. Configure here.