Skip to content

Commit a547cfe

Browse files
authored
Fix typo in docs (#61)
Motivation: The "PathToUnderscores" options was incorrectly spelled "PathToUnderscore" in the docs. Motivation: - Add the missing "s" Result: More accurate docs.
1 parent ac5100a commit a547cfe

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Sources/GRPCProtobuf/Documentation.docc/Articles/Generating-stubs.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -133,19 +133,19 @@ protoc \
133133

134134
#### Generator options
135135

136-
| Name | Possible Values | Default | Description |
137-
|---------------------------|--------------------------------------------|------------|----------------------------------------------------------|
138-
| `Visibility` | `Public`, `Package`, `Internal` | `Internal` | Access level for generated stubs |
139-
| `Server` | `True`, `False` | `True` | Generate server stubs |
140-
| `Client` | `True`, `False` | `True` | Generate client stubs |
141-
| `FileNaming` | `FullPath`, `PathToUnderscore`, `DropPath` | `FullPath` | How generated source files should be named. (See below.) |
142-
| `ProtoPathModuleMappings` | | | Path to module map `.asciipb` file. (See below.) |
143-
| `UseAccessLevelOnImports` | `True`, `False` | `False` | Whether imports should have explicit access levels. |
136+
| Name | Possible Values | Default | Description |
137+
|---------------------------|---------------------------------------------|------------|----------------------------------------------------------|
138+
| `Visibility` | `Public`, `Package`, `Internal` | `Internal` | Access level for generated stubs |
139+
| `Server` | `True`, `False` | `True` | Generate server stubs |
140+
| `Client` | `True`, `False` | `True` | Generate client stubs |
141+
| `FileNaming` | `FullPath`, `PathToUnderscores`, `DropPath` | `FullPath` | How generated source files should be named. (See below.) |
142+
| `ProtoPathModuleMappings` | | | Path to module map `.asciipb` file. (See below.) |
143+
| `UseAccessLevelOnImports` | `True`, `False` | `False` | Whether imports should have explicit access levels. |
144144

145145
The `FileNaming` option has three possible values, for an input of `foo/bar/baz.proto` the following
146146
output file will be generated:
147147
- `FullPath`: `foo/bar/baz.grpc.swift`.
148-
- `PathToUnderscore`: `foo_bar_baz.grpc.swift`
148+
- `PathToUnderscores`: `foo_bar_baz.grpc.swift`
149149
- `DropPath`: `baz.grpc.swift`
150150

151151
The code generator assumes all inputs are generated into the same module, `ProtoPathModuleMappings`

0 commit comments

Comments
 (0)