Skip to content

Commit be60cd9

Browse files
twpaynempvl
authored andcommitted
tools/trim: fix package doc
Currently the doc for `tools/trim` at https://godoc.org/cuelang.org/go shows: > light: ceiling50: { room: "MasterBedroom" brightnessOff: 0.0 // this line brightnessOn: 100.0 // and this line will be removed } This is due to a couple of blank lines in the `tools/trim` package comment. This PR fixes that, and a couple of typos. Closes #387 cuelang/cue#387 GitOrigin-RevId: 4943d4cbff641a3b308df15919154a71bf0ae59d Change-Id: I1c4e42e656b94698670678ec26e49663220133cc Reviewed-on: https://cue-review.googlesource.com/c/cue/+/6160 Reviewed-by: Marcel van Lohuizen <[email protected]>
1 parent 86e1a64 commit be60cd9

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

tools/trim/trim.go

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,13 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
// Package trim removes defintiions that may be inferred from
15+
// Package trim removes definitions that may be inferred from
1616
// templates.
1717
//
18-
// trim removes fields from structs that can be inferred from constraints
19-
2018
// A field, struct, or list is removed if it is implied by a constraint, such
21-
// as from an optional field maching a required field, a list type value,
19+
// as from an optional field matching a required field, a list type value,
2220
// a comprehension or any other implied content. It will modify the files in place.
23-
21+
//
2422
// Limitations
2523
//
2624
// Removal is on a best effort basis. Some caveats:
@@ -29,15 +27,15 @@
2927
// - Disjunctions that contain structs in implied content cannot be used to
3028
// remove fields.
3129
// - There is currently no verification step: manual verification is required.
32-
30+
//
3331
// Examples:
3432
//
3533
// light: [string]: {
3634
// room: string
3735
// brightnessOff: *0.0 | >=0 & <=100.0
3836
// brightnessOn: *100.0 | >=0 & <=100.0
3937
// }
40-
38+
//
4139
// light: ceiling50: {
4240
// room: "MasterBedroom"
4341
// brightnessOff: 0.0 // this line

0 commit comments

Comments
 (0)