Skip to content

Commit 466f82c

Browse files
committed
Fix some typos and grammars in writingzeppelininterpreter.md
1 parent d277c51 commit 466f82c

File tree

1 file changed

+17
-22
lines changed

1 file changed

+17
-22
lines changed

docs/development/writingzeppelininterpreter.md

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,8 @@ All Interpreters in the same interpreter group are launched in a single, separat
3232
### Make your own Interpreter
3333

3434
Creating a new interpreter is quite simple. Just extend [org.apache.zeppelin.interpreter](https://github.com/apache/incubator-zeppelin/blob/master/zeppelin-interpreter/src/main/java/org/apache/zeppelin/interpreter/Interpreter.java) abstract class and implement some methods.
35-
36-
You can include org.apache.zeppelin:zeppelin-interpreter:[VERSION] artifact in your build system.
37-
38-
Your interpreter name is derived from the static register method
35+
You can include `org.apache.zeppelin:zeppelin-interpreter:[VERSION]` artifact in your build system.
36+
Your interpreter name is derived from the static register method.
3937

4038
```
4139
static {
@@ -44,12 +42,11 @@ static {
4442
```
4543

4644
The name will appear later in the interpreter name option box during the interpreter configuration process.
47-
4845
The name of the interpreter is what you later write to identify a paragraph which should be interpreted using this interpreter.
4946

5047
```
5148
%MyInterpreterName
52-
some interpreter spesific code...
49+
some interpreter specific code...
5350
```
5451
### Install your interpreter binary
5552

@@ -63,33 +60,33 @@ Once you have build your interpreter, you can place your interpreter under direc
6360

6461
To configure your interpreter you need to follow these steps:
6562

66-
1. create conf/zeppelin-site.xml by copying conf/zeppelin-site.xml.template to conf/zeppelin-site.xml
63+
1. Create conf/zeppelin-site.xml by copying conf/zeppelin-site.xml.template to `conf/zeppelin-site.xml `.
6764

68-
2. Add your interpreter class name to the zeppelin.interpreters property in conf/zeppelin-site.xml
65+
2. Add your interpreter class name to the zeppelin.interpreters property in `conf/zeppelin-site.xml`.
6966

70-
Property value is comma separated [INTERPRETER_CLASS_NAME]
71-
for example,
67+
Property value is comma separated [INTERPRETER\_CLASS\_NAME].
68+
For example,
7269

7370
```
7471
<property>
7572
<name>zeppelin.interpreters</name>
7673
<value>org.apache.zeppelin.spark.SparkInterpreter,org.apache.zeppelin.spark.PySparkInterpreter,org.apache.zeppelin.spark.SparkSqlInterpreter,org.apache.zeppelin.spark.DepInterpreter,org.apache.zeppelin.markdown.Markdown,org.apache.zeppelin.shell.ShellInterpreter,org.apache.zeppelin.hive.HiveInterpreter,com.me.MyNewInterpreter</value>
7774
</property>
7875
```
79-
3. start zeppelin by running ```./bin/zeppelin-deamon start```
76+
3. Start zeppelin by running `./bin/zeppelin-daemon start`.
8077

81-
4. in the interpreter page, click the +Create button and configure your interpreter properties.
78+
4. In the interpreter page, click the +Create button and configure your interpreter properties.
8279
Now you are done and ready to use your interpreter.
8380

84-
Note that the interpreters shipped with zeppelin have a [default configuration](https://github.com/apache/incubator-zeppelin/blob/master/zeppelin-zengine/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java#L397) which is used when there is no zeppelin-site.xml.
81+
Note that the interpreters shipped with zeppelin have a [default configuration](https://github.com/apache/incubator-zeppelin/blob/master/zeppelin-zengine/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java#L397) which is used when there is no `conf/zeppelin-site.xml`.
8582

8683
### Use your interpreter
8784

8885
#### 0.5.0
89-
Inside of a notebook, %[INTERPRETER_NAME] directive will call your interpreter.
86+
Inside of a notebook, `%[INTERPRETER_NAME]` directive will call your interpreter.
9087
Note that the first interpreter configuration in zeppelin.interpreters will be the default one.
9188

92-
for example
89+
For example,
9390

9491
```
9592
%myintp
@@ -100,16 +97,14 @@ println(a)
10097

10198
<br />
10299
#### 0.6.0 and later
103-
Inside of a notebook, %[INTERPRETER\_GROUP].[INTERPRETER\_NAME] directive will call your interpreter.
100+
Inside of a notebook, `%[INTERPRETER_GROUP].[INTERPRETER_NAME]` directive will call your interpreter.
104101
Note that the first interpreter configuration in zeppelin.interpreters will be the default one.
105102

106-
You can omit either [INTERPRETER\_GROUP] or [INTERPRETER\_NAME]. Omit [INTERPRETER\_NAME] selects first available interpreter in the [INTERPRETER\_GROUP].
107-
Omit '[INTERPRETER\_GROUP]' will selects [INTERPRETER\_NAME] from default interpreter group.
108-
103+
You can omit either [INTERPRETER\_GROUP] or [INTERPRETER\_NAME]. If you omit [INTERPRETER\_NAME], then first available interpreter will be selected in the [INTERPRETER\_GROUP].
104+
Likewise, if you skip [INTERPRETER\_GROUP], then [INTERPRETER\_NAME] will be chosen from default interpreter group.
109105

110-
For example, if you have two interpreter myintp1 and myintp2 in group mygrp,
111106

112-
you can call myintp1 like
107+
For example, if you have two interpreter myintp1 and myintp2 in group mygrp, you can call myintp1 like
113108

114109
```
115110
%mygrp.myintp1
@@ -125,7 +120,7 @@ and you can call myintp2 like
125120
codes for myintp2
126121
```
127122

128-
If you omit your interpreter name, it'll selects first available interpreter in the group (myintp1)
123+
If you omit your interpreter name, it'll select first available interpreter in the group ( myintp1 ).
129124

130125
```
131126
%mygrp

0 commit comments

Comments
 (0)