Skip to content

Commit e38248d

Browse files
committed
Reflow the text
1 parent f028db8 commit e38248d

1 file changed

Lines changed: 15 additions & 16 deletions

File tree

docs/for-contributors/Generator/name-processing.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -39,30 +39,29 @@ This section explains how names flow through the SilkTouch generator pipeline.
3939

4040
## Test cases
4141

42-
The behavior for the name processing pipeline is heavily unit tested.
43-
Please refer to the unit tests for the corresponding section of the codebase to see detailed examples
44-
of expected inputs and outputs.
42+
The behavior for the name processing pipeline is heavily unit tested. Please refer to the unit tests for the
43+
corresponding section of the codebase to see detailed examples of expected inputs and outputs.
4544

4645
## PrettifyNames
4746

4847
As seen above, `PrettifyNames` is the mod central to name processing.
4948

50-
The goal of this mod is to take all of the names from the generated bindings and transform them in bulk.
51-
This keeps other mods performant and simple, as renaming identifiers is a costly operation
52-
that involves searching the entire project for references to that identifier.
49+
The goal of this mod is to take all of the names from the generated bindings and transform them in bulk. This keeps
50+
other mods performant and simple, as renaming identifiers is a costly operation that involves searching the entire
51+
project for references to that identifier.
5352

54-
Despite this, `PrettifyNames` also has the goal of remaining dumb and straightforward.
55-
It relies on the generator config for API-specific decisions (eg: removing/reordering affixes, overrides)
56-
and other mods for API-specific annotations (eg: API-specific prefix/suffix conventions).
57-
The rest of the processing (eg: prettification), while complex, is done uniformly.
53+
Despite this, `PrettifyNames` also has the goal of remaining dumb and straightforward. It relies on the generator config
54+
for API-specific decisions (eg: removing/reordering affixes, overrides) and other mods for API-specific annotations
55+
(eg: API-specific prefix/suffix conventions). The rest of the processing (eg: prettification), while complex, is done
56+
uniformly.
5857

59-
This allows `PrettifyNames` to focus strictly on the common case, while edge cases are handled elsewhere.
60-
This works fairly well in practice. Even though the configuration options are limited mostly to how affixes are
61-
handled, affixes are usually where native APIs differ in their naming conventions. Other differences fall outside
62-
the common case and are therefore handled by the generator user or by other mods.
58+
This allows `PrettifyNames` to focus strictly on the common case, while edge cases are handled elsewhere. This works
59+
fairly well in practice. Even though the configuration options are limited mostly to how affixes are handled, affixes
60+
are usually where native APIs differ in their naming conventions. Other differences fall outside the common case and are
61+
therefore handled by the generator user or by other mods.
6362

64-
Furthermore, to keep `PrettifyNames` simple and linear, each step takes the output of the previous step,
65-
with no interweaving of logic.
63+
Furthermore, to keep `PrettifyNames` simple and linear, each step takes the output of the previous step, with no
64+
interweaving of logic.
6665

6766
`PrettifyNames` works as follows:
6867

0 commit comments

Comments
 (0)