Update README.md to emphasize that CustomJS only supports single class definition per file#104
Merged
Merged
Conversation
…s definitions per file. Added examples of incorrect and correct usage to clarify the requirements for file structure.
Owner
|
I appreciate the attempt, hopefully it makes a difference. Many people in open source create an issue before reading the documentation, so there's only so much you can do 🤷🏼♂️ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I just tried using CustomJS … and couldn't figure out how to make it work, until I went in the issues sections and found that the explanation was (as often), that we collectively tend to skim the doc and skip the part where CustomJS only supports single class definition per file
I've added examples of incorrect and correct usage to clarify the requirements for file structure
Hope it will help other users
(And by the way, thanks for maintaining the plugin 🙏)