docs(Dropdown): added comments for shape of options #1086
Merged
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
Current coverage is 95.83% (diff: 100%)@@ master #1086 diff @@
==========================================
Files 873 873
Lines 4827 4827
Methods 0 0
Messages 0 0
Branches 0 0
==========================================
Hits 4626 4626
Misses 201 201
Partials 0 0
|
levithomason
requested changes
Dec 27, 2016
There was a problem hiding this comment.
Awesome! This was on my bucket list. I've left a couple comments on formatting. We reserve /** doc blocks for external documentation. I'd like to keep the comments as small as possible. I've left two examples of how I'd like to refactor these. LMK if there are any questions. Thanks again!
| /** stateOptions shape **/ | ||
| /** | ||
| [ | ||
| { value: 'AL', text: 'Alabama' }, |
There was a problem hiding this comment.
Let's shorten all examples that have single-line option objects:
/** stateOptions shape **/
/**
[
{ value: 'AL', text: 'Alabama' },
{ value: 'AK', text: 'Alaska' },
{ value: 'AZ', text: 'Arizona' },
...
]
**/Into this style comment:
// stateOptions = [{ value: 'AL', text: 'Alabama' }, ...{}]
modified comments to conform to project standards
fobbyal
force-pushed
the
drop-down-option-shapes
branch
from
0bc4019 to
1c65e84
Compare
|
amended the commit. please take a look... i had to do multi-line on some of them because they didn't really fit if they were one liners. let me know what you think |
|
Thanks much! |
levithomason
approved these changes
Dec 27, 2016
levithomason
changed the title
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.
took the liberty to add the shape of the options on examples. Just thought it would be helpful. I had to find the
../common.jsfile myself.