Fix the errors in Readme and enhance its clarity #37
Conversation
This file contains 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
Collaborator
OliviaLan
commented
May 30, 2022
OliviaLan
commented
- fix grammar errors and inaccurate expressions
- examples of string var should be written as string (e.g., "mode": light/dark --> "mode": "light"/"dark"; "channel": x/y/color/size/theta --> channel: "x"/"y"/"color"/"size"/"theta") to prevent misunderstanding?
- unify the demonstration of var type (e.g., "font-size": size --> "font-size": int)
- modify the order of annotations (from changing the graphical appearance of the mark itself to adding additional elements) and remove "distribution"
- fix inconsistent expressions (e.g., optional features are all written with: // (optional) )
- reindex the action list (starting from 1 seems to be more consistent with other sections)
- in "add image" action, "width" and "height' are optional? I have added // (optional) to these two items
- examples of string var should be written as string (e.g., "mode": "light"/"dark") - fix grammar errors or inappropriate expressions - unify the expreesion of var type (e.g., "font-size": size --> "font-size": int) - modify the order of annoations (from changing the graphical appeareance of the mark itself to adding additional elements) and remove "distribution"
1. string var ("channel": "x"/"y"/"color"/"size"/"theta")
2. check the format
3. reindex the action list (starting from 1 seems more consistent with other sections)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.