chore: update colour readme to include more information about field customization #2319
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
rachel-fenichel
changed the title
maribethb
reviewed
Apr 9, 2024
plugins/field-colour/README.md
Outdated
|
|
||
| #### Colour field on collapsed block | ||
|
|
||
|  | ||
|
|
||
| If you want to use only the field, you must register it with Blockly. You can |
There was a problem hiding this comment.
This paragraph is now under the "Colour field on collapsed block" heading, which is awkward. I would move it directly under the ## Usage headline.
Also, I have suggestions for the paragraph itself:
- the word "only" is confusing here because we haven't introduced any context that would explain what the alternative is (i.e. if not "only" then what else?).
- say the name of the field in that part of the explanation.
- add a link to the install blocks section
So I would change this paragraph to say:
If you want to use this field in a block definition, you must install it by calling `registerFieldColour` before instantiating your blocks. If another field is registered under the same name (`field_colour`), this field will overwrite it.
If you [install the blocks](#blocks) in this package, the field will automatically be installed.
plugins/field-colour/README.md
Outdated
| The colour constructor takes in the following: | ||
|
|
||
| - an optional `value` | ||
| - an optional [validator](#creating_a_colour_validator) |
There was a problem hiding this comment.
this (and other links) should use - instead of _
if you click "view file" in the ... menu in this PR you can preview the rendered file and see thin links
There was a problem hiding this comment.
Done. Thanks.
plugins/field-colour/README.md
Outdated
|
|
||
| ### Editor options | ||
|
|
||
| The setColours |
There was a problem hiding this comment.
add backticks around setColours
maribethb
approved these changes
Apr 10, 2024
gonfunko
pushed a commit
to gonfunko/blockly-samples
that referenced
this pull request
Apr 15, 2024
…ustomization (google#2319) * chore: update field-colour readme to include information from devsite * chore: line length * chore: show colourOptions in colour field sample code * chore: format * chore: respond to review feedback
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.
The basics
The details
Resolves
Fixes #2216
Fixes google/blockly#7878
Proposed Changes
Combines documentation from deviste and existing README.
Reason for Changes
This field will no longer be documented on devsite.
Test Coverage
Documentation
This is documentation! But also, devsite should probably have a pointer to the fields on gh-pages in addition to the individual pages for built-in fields.
Additional Information
I can't tell if the section links with
#section_namewill work in GitHub markdown.