Skip to content

Commit 8092659

Browse files
authored
Fix docs formatting typo
fix: docs typo
2 parents 3a2ff39 + 3830c35 commit 8092659

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/decisions/0002-feature-based-application-organization.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,11 @@ This section details a specific taxonomy and hierarchy to help make code modular
7575
In order to isolate our view layer (React) from the management of our data, global state, APIs, and side effects, we want to adopt the "ducks" organization (see references). This involves isolating data management into a
7676
sub directory of a feature. We'll use the directory name "data" rather than the traditional "ducks".
7777

78-
**C. React components will be named semantically.**
78+
**B. React components will be named semantically.**
7979

8080
The convention for React components is for the file to be named for what the component does, so we will preserve this. A given feature may break up its view layer into multiple sub-components without a sub-feature being present.
8181

82-
**B. Files in a module's data directory are named by function.**
82+
**C. Files in a module's data directory are named by function.**
8383

8484
In the data sub-directory, the file names describe what each piece of code does. Unlike React components, all of the data handlers (actions, reducers, sagas, selectors, services, etc.) are generally short functions, and so we put them all in the same file together with others of their kind.
8585

@@ -99,7 +99,7 @@ In the data sub-directory, the file names describe what each piece of code does.
9999

100100
If you find yourself desiring to have multiple files of a particular type in the data directory, this is a strong sign that you actually need a sub-feature instead.
101101

102-
**C. Sub-features follow the same naming scheme.**
102+
**D. Sub-features follow the same naming scheme.**
103103

104104
Sub-features should follow the same rules as any other module.
105105

@@ -147,7 +147,7 @@ As described above in "Avoid circular dependencies", features should not import
147147

148148
The feature may only import from the exports of its child, which may include exports of the grandchildren. Importing directly from grandchildren (or great grandchildren, etc.) would violate the strict module boundary of the child.
149149

150-
**II. Features may import from their siblings.**
150+
**III. Features may import from their siblings.**
151151

152152
It's acceptable to import from a module's siblings, or the siblings of their parents, grandparents, etc. This is necessary to support code re-use. As an example, assume we have a sub-module with common code to support our web forms.
153153

@@ -160,7 +160,7 @@ It's acceptable to import from a module's siblings, or the siblings of their par
160160

161161
The sub-form modules can import from forms-common-code. The latter has its own strict module boundary and could conceptually be extracted into its own repository/completely independent module as far as they're concerned. They're unaware, conceptually, that it's a child of feature1, and they don't care.
162162

163-
**III. Features may import from the siblings of their parentage.**
163+
**IV. Features may import from the siblings of their parentage.**
164164

165165
This is less intuitive, but is not really any different than the above.
166166

0 commit comments

Comments
 (0)