Update readme with descriptions of which step options are required #235
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
RobbieTheWagner
requested changes
Sep 6, 2018
README.md
Outdated
| ##### beforeShowPromise | ||
|
|
||
| A function that returns a promise. When the promise resolves, the rest of the `show` code for the step will execute. This is a good place to schedule things in the Ember.run loop that you need to ensure happen before show. | ||
|
|
||
| > **required:** `no` |
There was a problem hiding this comment.
Can we use required and optional as the descriptors instead? This addon would also be another candidate for ember-cli-addon-docs, where we can make much nicer docs.
There was a problem hiding this comment.
So instead of "yes" or "no", you're thinking just saying something like:
required
or
optional
There was a problem hiding this comment.
Yep, exactly or we wouldn't even need to say optional, we could just mark required ones, but either way.
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.
I also elaborated on the defaults for a few options.