Rewrite docs for new builder process #157
Merged
Conversation
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
Codecov Report
@@ Coverage Diff @@
## master #157 +/- ##
============================================
+ Coverage 97.83% 98.21% +0.37%
- Complexity 417 482 +65
============================================
Files 25 25
Lines 1294 1401 +107
============================================
+ Hits 1266 1376 +110
+ Misses 28 25 -3
Continue to review full report at Codecov.
|
Lynesth
reviewed
May 16, 2018
README.md
Outdated
| 2. `addSplitItem` returns an instance of `SplitItemBuilder`, the main menu will take care of building all split items (and any submenu they might contain). | ||
| 3. You can call `addItem`, `addSubMenu` and `addStaticItem` on the `SplitItemBuilder`. | ||
| 4. Like when building submenus, you can call `end()` on the Split Item `SplitItemBuilder` instance to get the parent `CliMenuBuilder` back again. This is useful for chaining. | ||
| 1. The first parameter to `addSubMenu` is a closure, which will be invoked with a new instance of `SplitItemBuilder` which you can use to add items to the split item. |
There was a problem hiding this comment.
addSplitItem not addSubMenu
| 4. Like when building submenus, you can call `end()` on the Split Item `SplitItemBuilder` instance to get the parent `CliMenuBuilder` back again. This is useful for chaining. | ||
| 1. The first parameter to `addSubMenu` is a closure, which will be invoked with a new instance of `SplitItemBuilder` which you can use to add items to the split item. | ||
| 2. You can call `addItem`, `addSubMenu` and `addStaticItem` on the `SplitItemBuilder`. | ||
| 3. `SplitItemBuilder` has a fluent interface so you can chain method calls. |
There was a problem hiding this comment.
Add a note that like the addSubMenu, the closure used to build the splititem is also binded with the SplitItemBuilder blablabla
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.
No description provided.