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

Improve MacroTesting Documentation and Add Swift Testing Integration #35

Merged
merged 2 commits into from
Jan 20, 2025

Conversation

ajkolean
Copy link
Contributor

This PR updates the documentation, comments, and examples in the Macro Testing library to reflect the use of the record parameter instead of the outdated isRecording bool.

Changes Include:

  • Updated inline comments in AssertMacro.swift to clarify the record parameter's role and its integration with SNAPSHOT_TESTING_RECORD.
  • Enhanced examples in the README to highlight how record can be used with withMacroTesting and the Swift Testing framework.
  • Removed unnecessary @_spi(Experimental) annotations, aligning with conventions in the related SnapshotTesting library.
  • Ensured that all references to isRecording are replaced with record for consistency.

What’s The Point:

  • These changes ensure that users have accurate, clear, and consistent guidance when using the library.
  • While the API itself remains unchanged, the improvements in documentation reduce confusion and make the library easier to adopt.

⠀### Backward Compatibility:

  • No breaking changes were introduced, as this PR only updates documentation and comments.

Copy link
Member

@stephencelis stephencelis left a comment

Choose a reason for hiding this comment

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

This looks great, thanks for your help!

@stephencelis stephencelis merged commit 5e54f49 into pointfreeco:main Jan 20, 2025
2 checks passed
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