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

Add comments to CodeMirror Plugin for improved clarity #315

Open
devleejb opened this issue Aug 24, 2024 · 1 comment
Open

Add comments to CodeMirror Plugin for improved clarity #315

devleejb opened this issue Aug 24, 2024 · 1 comment
Labels
enhancement 🌟 New feature or request

Comments

@devleejb
Copy link
Member

What would you like to be added:

Currently, in CodePair, we are using the remoteSelection and yorkieSync plugins for the integration of Yorkie. However, the complex logic within these plugins makes them difficult to understand. To enhance clarity and usability, I propose adding comments throughout the code of these plugins.

Why is this needed:

Adding comments will help developers understand the functionality and flow of the code better, making it easier to maintain and modify in the future. This will also facilitate onboarding for new developers working with the CodeMirror plugin.

Additional Information:

@devleejb
Copy link
Member Author

devleejb commented Aug 24, 2024

We can refer these documentations.

When I write this code, I used the structure of y-codemirror.next.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement 🌟 New feature or request
Projects
Status: Backlog
Status: Backlog
Development

No branches or pull requests

1 participant