Skip to content

Commit a9c52e2

Browse files
committedMar 18, 2023
Add notes to docs about new annotation model
- Relates #637
1 parent cfd2b7f commit a9c52e2

File tree

3 files changed

+21
-15
lines changed

3 files changed

+21
-15
lines changed
 
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[[using-shell-basics-reading]]
2+
=== Reading Docs
3+
4+
Throughout this documentation, we make references to configuring something by using
5+
annotations or programmatic examples.
6+
7+
NOTE: There are two annotation models, <<commands-registration-annotation, annotations>>
8+
referred to new annotation model, <<commands-registration-legacyannotation, legacy annotations>>
9+
referred to old legacy annotation model.
10+
11+
Old legacy annotation model mostly relates to use of `@ShellMethod` and `@ShellOption` and
12+
new annotation model relates to use of `@Command`.
13+
14+
The programmatic model is how things are actually registered, even if you use annotations.
15+
16+
NOTE: Currently whole documentation structure is in transit to provide better
17+
structure how things can be used using different ways to provide configurations.
18+
So pardon a for little confusion now and there during a transit.

‎spring-shell-docs/src/main/asciidoc/using-shell-basics.adoc

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,4 @@ Essentially, a few things needs to happen before you have a working Spring Shell
1313
You can get a full working Spring Shell application without defining any user-level commands
1414
as some basic built-in commands (such as `help` and `history`) are provided.
1515

16-
[NOTE]
17-
====
18-
Throughout this documentation, we make references to configuring something by using
19-
annotations (mostly relates to use of `@ShellMethod` and `@ShellOption`) and to the
20-
programmatic way (which uses `CommandRegistration`).
21-
22-
The programmatic model is how things are actually registered, even if you use annotations.
23-
The `@ShellMethod` and `@ShellOption` annotations are a legacy feature
24-
that we do not yet want to remove. `CommandRegistration` is the new development
25-
model where new features are added. We are most likely going to replace existing
26-
annotations with something better, to support new features in a
27-
`CommandRegistration` model.
28-
====
16+
include::using-shell-basics-reading.adoc[]

‎spring-shell-docs/src/main/asciidoc/using-shell-commands-registration.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ part without breaking existing applications.
1616

1717
include::using-shell-commands-registration-annotation.adoc[]
1818

19-
include::using-shell-commands-registration-legacyannotation.adoc[]
20-
2119
include::using-shell-commands-registration-programmatic.adoc[]
20+
21+
include::using-shell-commands-registration-legacyannotation.adoc[]

0 commit comments

Comments
 (0)
Please sign in to comment.