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

doc(Delta): more documentation about Delta #2042

Merged
merged 3 commits into from
Jul 20, 2024
Merged

doc(Delta): more documentation about Delta #2042

merged 3 commits into from
Jul 20, 2024

Conversation

CatHood0
Copy link
Collaborator

Description

Added more documentation for Delta, works, and examples about it.

  • New feature: Adds new functionality without breaking existing features.
  • 🛠️ Bug fix: Resolves an issue without altering current behavior.
  • 🧹 Code refactor: Code restructuring that does not affect behavior.
  • Breaking change: Alters existing functionality and requires updates.
  • 🧪 Tests: Adds new tests or modifies existing tests.
  • 📝 Documentation: Updates or additions to documentation.
  • 🗑️ Chore: Routine tasks, or maintenance.
  • Build configuration change: Changes to build or deploy processes.

@CatHood0 CatHood0 changed the title doc(Delta): added documentation about Deltas doc(Delta): more documentation about Delta Jul 20, 2024
@singerdmx singerdmx merged commit 689b8fd into singerdmx:master Jul 20, 2024
2 checks passed
You can import `Delta` and `Operation` class using:

```dart
import 'package:flutter_quill/dart_quill_delta.dart';
Copy link
Collaborator

@EchoEllet EchoEllet Jul 20, 2024

Choose a reason for hiding this comment

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

This could be quill_delta instead of dart_quill_delta

Copy link
Collaborator Author

@CatHood0 CatHood0 Jul 21, 2024

Choose a reason for hiding this comment

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

I already checked this, and i always need to import dart_quill_delta to get Delta and Operation classes. Why do you are suggesting that change?

Copy link
Collaborator

@EchoEllet EchoEllet Jul 21, 2024

Choose a reason for hiding this comment

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

So developers don't have to add dart_quill_delta explicitly in their pubspec.yaml, we can export additional required files or export dart_quill_delta

In case breaking changes are introduced, it would require fewer steps to use Delta and Operation when using flutter_quill

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.

3 participants