Skip to content

Remove Refreshable & Resettable from readme #189

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

Merged
merged 1 commit into from
Jun 3, 2025
Merged

Remove Refreshable & Resettable from readme #189

merged 1 commit into from
Jun 3, 2025

Conversation

ra1028
Copy link
Owner

@ra1028 ra1028 commented Jun 3, 2025

Pull Request Type

  • Bug fix
  • New feature
  • Refactoring
  • Documentation update
  • Chore

@Copilot Copilot AI review requested due to automatic review settings June 3, 2025 09:54
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the documentation by removing references to Refreshable and Resettable from the primary documentation and README, categorizing them as deprecated in Atoms.docc instead.

  • Removed Refreshable and Resettable from the main list in Atoms.docc
  • Added Refreshable and Resettable to the Deprecated section in Atoms.docc
  • Removed the entire Refreshable and Resettable documentation block from the README

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
Sources/Atoms/Atoms.docc/Atoms.md Moved Refreshable and Resettable items to the Deprecated section
README.md Removed the Refreshable and Resettable sections and examples
Comments suppressed due to low confidence (2)

README.md:865

  • The removal of the Refreshable section from the README is clear. Consider verifying that users have been adequately informed of the deprecation in other documentation.
-#### [Refreshable](https://ra1028.github.io/swiftui-atom-properties/documentation/atoms/refreshable)

Sources/Atoms/Atoms.docc/Atoms.md:96

  • Refreshable is now categorized under Deprecated. Please ensure that any related documentation or cross-references are updated for consistency.
+- ``Refreshable``

@ra1028 ra1028 merged commit 0b67111 into main Jun 3, 2025
6 checks passed
@ra1028 ra1028 deleted the update-readme branch June 3, 2025 10:13
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.

1 participant