Skip to content

Commit e3cb937

Browse files
committed
Update documentation
1 parent d909f79 commit e3cb937

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+182
-189
lines changed

spring-shell-docs/modules/ROOT/pages/appendices/techintro/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[appendix]
22
[#appendix-tech-intro]
3-
= Techical Introduction
3+
= Technical Introduction
44
:page-section-summary-toc: 1
55

66
This appendix contains information for developers and others who would like to know more about how Spring Shell

spring-shell-docs/modules/ROOT/pages/appendices/tui/catalog.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
ifndef::snippets[:snippets: ../../../../../src/test/java/org/springframework/shell/docs]
66

7-
Catalog application is showing various ways how Terminal UI Framework can be used.
8-
In this section we discuss how this application works. It can be considered to be
7+
Catalog application shows various ways how the Terminal UI Framework can be used.
8+
In this section, we discuss how this application works. It can be considered as
99
a reference application as it's using most of the features available and tries
10-
to follow best practices.
10+
to follow the best practices.
1111

1212
[[create-scenario]]
1313
== Create Scenario

spring-shell-docs/modules/ROOT/pages/appendices/tui/index.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
77

8-
This is a technical introduction to _UI Framework_.
8+
This is a technical introduction to the _UI Framework_.
99

10-
_UI Framework_ is a toolkit to build rich console apps.
10+
The _UI Framework_ is a toolkit to build rich console apps.
1111

1212

1313

spring-shell-docs/modules/ROOT/pages/appendices/tui/viewdev.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
= View Development
33
:page-section-summary-toc: 1
44

5-
While a _view_ just need to implement `View` it's usually convenient to just
5+
While a _view_ just needs to implement `View`, it's usually convenient to just
66
use `BoxView` as a parent.
77

88
[[register-bindings]]

spring-shell-docs/modules/ROOT/pages/basics/reading.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
Throughout this documentation, we make references to configuring something by using
66
annotations or programmatic examples.
77

8-
NOTE: There are two annotation models, xref:commands/registration/annotation.adoc[annotations]
9-
referred to new annotation model, xref:commands/registration/legacyannotation.adoc[legacy annotations]
10-
referred to old legacy annotation model.
8+
NOTE: There are two annotation models: the xref:commands/registration/annotation.adoc[annotations] model
9+
referred to as the new annotation model, and the xref:commands/registration/legacyannotation.adoc[legacy annotations]
10+
model referred to as the old legacy annotation model.
1111

12-
Old legacy annotation model mostly relates to use of `@ShellMethod` and `@ShellOption` and
13-
new annotation model relates to use of `@Command`.
12+
The old legacy annotation model mostly relates to the use of `@ShellMethod` and `@ShellOption` and
13+
the new annotation model relates to the use of `@Command`.
1414

1515
The programmatic model is how things are actually registered, even if you use annotations.
1616

17-
NOTE: The documentation structure is getting revised to clarify how to provide configurations in separate ways. Thank you for understanding while that work is still in progress.
17+
NOTE: The documentation structure is getting revised to clarify how to provide configurations in separate ways.

spring-shell-docs/modules/ROOT/pages/building.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,17 @@ traditionally been relatively complex process while it may look like
2525
there's not that much happening as it's all just text.
2626

2727
Remember all those old manual typewriters or matrix printers?
28-
A character is printed where a cursor is which then need to be moved
28+
A character is printed then a cursor needs to be moved
2929
if printing in a different position. In a nutshell that's how current
3030
terminal emulators work.
3131

32-
To access and understand existing terminal emulator environment better
32+
To access and understand existing terminal emulators environment better,
3333
JLine can use native code via its own shared libraries. JLine detects
3434
which providers are present and then makes a choice which one to use.
3535
Traditionally there's been 3 providers, `jansi`, `jni` and `jna` which
3636
should all provide same functionalities.
3737

38-
Our starters can be used to spesifically pick some of these JLine
38+
Our starters can be used to specifically pick some of these JLine
3939
providers.
4040

4141
== FFM
@@ -127,7 +127,7 @@ When gradle build is run with `./gradlew nativeCompile` you should get binary
127127
under `build/native/nativeCompile` directory.
128128

129129
For `maven` use `spring-boot-starter-parent` as parent and you'll get `native`
130-
profile which can be used to do a compilation. You need to configure metadata repository
130+
profile which can be used to do a native compilation. You need to configure metadata repository:
131131

132132
[source, xml, subs=attributes+]
133133
----

spring-shell-docs/modules/ROOT/pages/commands/alias.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,9 @@ cases where you want to create a shorter version of a command or going
88
through a complete command rename while keeping old one temporarily in
99
place.
1010

11-
Format for _alias_ is slighly different than a _command_. When _command_
11+
The format of _alias_ is slightly different from a _command_. When _command_
1212
is defined as an array it's concatenated together into a single command.
13-
When _alias_ is defined as an array it's used to create a separate
14-
aliases.
13+
When _alias_ is defined as an array it's used to create separate aliases.
1514

1615
Aliases with a plain `CommandRegistration` is simple and clear as you
1716
get exactly what you define as there's no "magic" in it.

spring-shell-docs/modules/ROOT/pages/commands/builtin/clear.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
= Clear
33
:page-section-summary-toc: 1
44

5-
The `clear` command does what you would expect and clears the screen, resetting the prompt
5+
The `clear` command clears the screen, resetting the prompt
66
in the top left corner.

spring-shell-docs/modules/ROOT/pages/commands/builtin/completion.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
= Completion
33
:page-section-summary-toc: 1
44

5-
The `completion` command set lets you create script files that can be used
6-
with am OS shell implementations to provide completion. This is very useful when
5+
The `completion` command lets you create script files that can be used
6+
with an OS shell implementation to provide completion. This is very useful when
77
working with non-interactive mode.
88

9-
Currently, the only implementation is for bash, which works with `bash` sub-command.
9+
Currently, the only implementation is for bash, which works with the `bash` sub-command.

spring-shell-docs/modules/ROOT/pages/commands/builtin/help.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22
= Help
33

44
Running a shell application often implies that the user is in a graphically limited
5-
environment. Also, while we are nearly always connected in the era of mobile phones,
6-
accessing a web browser or any other rich UI application (such as a PDF viewer) may not always
7-
be possible. This is why it is important that the shell commands are correctly self-documented, and this is where the `help`
5+
environment. This is why it is important that the shell commands are correctly self-documented, and this is where the `help`
86
command comes in.
97

108
Typing `help` + `ENTER` lists all the commands known to the shell (including xref:commands/availability.adoc[unavailable] commands)

0 commit comments

Comments
 (0)