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

Update README #54

Merged
merged 2 commits into from
Mar 10, 2025
Merged

Update README #54

merged 2 commits into from
Mar 10, 2025

Conversation

hkusu
Copy link
Member

@hkusu hkusu commented Mar 9, 2025

This pull request includes updates to the README.md file to provide additional information on handling state persistence in the Tart library. The most important changes include adding details about the StateSaver implementations and fixing a minor formatting issue.

Enhancements to state persistence documentation:

  • README.md: Added a section describing two types of StateSaver implementations: Persistent State Saver and Retained State Saver. This includes details on their usage, dependencies, and limitations.

Minor formatting fix:

  • README.md: Corrected the indentation in the code example for creating a ViewStore instance.

@hkusu hkusu force-pushed the update_readme_saver branch from 4d47eb4 to f283b06 Compare March 9, 2025 10:30
@hkusu hkusu requested a review from Copilot March 9, 2025 12:00

Choose a reason for hiding this comment

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

PR Overview

This PR updates the README documentation by fixing a code snippet and adding detailed information about the new StateSaver implementations available in Tart.

  • Fixed a missing closing brace in a code sample.
  • Added comprehensive documentation for both Persistent and Retained StateSaver implementations.
  • Corrected the formatting in a code snippet by removing an unintended backtick.

Reviewed Changes

File Description
README.md Updated code sample by adding missing closing brace, expanded documentation on StateSaver types, and fixed formatting in a code snippet.

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

Base automatically changed from retained_saver to main March 10, 2025 07:07
@hkusu hkusu enabled auto-merge March 10, 2025 07:49
@hkusu hkusu merged commit 5f88076 into main Mar 10, 2025
3 checks passed
@hkusu hkusu deleted the update_readme_saver branch March 10, 2025 07:58
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