[ZEPPELIN-1462] Zeppelin-Web Good Practices #3#1443
Closed
corneadoug wants to merge 2 commits intoapache:gh-pagesfrom
Closed
[ZEPPELIN-1462] Zeppelin-Web Good Practices #3#1443corneadoug wants to merge 2 commits intoapache:gh-pagesfrom
corneadoug wants to merge 2 commits intoapache:gh-pagesfrom
Conversation
Contributor
Author
|
@AhyoungRyu Since you always find a few mistakes, can you make a quick spell check like always? :) |
prabhjyotsingh
requested changes
Sep 21, 2016
| <br/> | ||
| Our main rule regarding writing a controller, is to use the `Controller as vm` style. | ||
|
|
||
| However we also have a few other style guidelines. |
Contributor
Author
There was a problem hiding this comment.
@prabhjyotsingh You really like that comma :)
AhyoungRyu
reviewed
Sep 21, 2016
| </div> | ||
| ``` | ||
|
|
||
| #### Using the controller in a a page |
| However we also have a few other style guidelines. | ||
|
|
||
| You can see below a full example of what the controller would look like. | ||
|
|
Contributor
There was a problem hiding this comment.
Do we need additional new lines? How about putting those three lines in one line? I mean
Our main rule regarding writing a controller, is to use the `Controller as vm` style.
However we also have a few other style guidelines. You can see below a full example of what the controller would look like.
Contributor
Author
There was a problem hiding this comment.
I would have prefered those lines to be one under another without any additional spacing, but If I don't have that new line, the You can goes straight on the right side of the previous sentence
Contributor
Author
There was a problem hiding this comment.
Eventually I could group the first two sentences:
Our main rule regarding writing a controller, is to use the `Controller as vm` style, however, we also have a few other style guidelines.
Contributor
Author
|
Changes done. |
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
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.
What is this PR for?
This Good Practice Guide will focus on how to write a controller following the controller as vm concept, and how to provide a nice separation of the code.
What type of PR is it?
Documentation
What is the Jira issue?
https://issues.apache.org/jira/browse/ZEPPELIN-1462
How should this be tested?
Check the
.mdfile, or build the website to see the full renderingQuestions: