Fix the doc comments referring to the extant ClearBuiltins() option #345
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sfllaw
reviewed
Apr 30, 2020
There was a problem hiding this comment.
It seems that you might have missed this mention:
https://github.com/TristonianJones/cel-go/blob/doc-fix/cel/options.go#L95
cel/options.go
Outdated
| @@ -68,7 +65,9 @@ func CustomTypeProvider(provider ref.TypeProvider) EnvOption { | |||
|
|
|||
| // Declarations option extends the declaration set configured in the environment. | |||
| // | |||
| // Note: This option must be specified after ClearBuiltIns if both are used together. | |||
| // Note: Declarations will by default be appended to the pre-existing declaration set cnofigured | |||
There was a problem hiding this comment.
Spelling:
Suggested change
| // Note: Declarations will by default be appended to the pre-existing declaration set cnofigured | |
| // Note: Declarations will by default be appended to the pre-existing declaration set configured |
cel/options.go
Outdated
Comment on lines
69
to
70
| // for the environment. The cel.NewEnv call builds on top of the standard CEL declarations. For | ||
| // a purely custom set of declarations use cel.NewCustomEnv. |
There was a problem hiding this comment.
This is the only place in the documentation where you use the namespaced name in the doc comment. Since this function also lives in cel, perhaps it is unnecessary?
Suggested change
| // for the environment. The cel.NewEnv call builds on top of the standard CEL declarations. For | |
| // a purely custom set of declarations use cel.NewCustomEnv. | |
| // for the environment. The NewEnv call builds on top of the standard CEL declarations. For | |
| // a purely custom set of declarations use NewCustomEnv. |
|
@sfllaw Thanks for the review. |
JimLarson
approved these changes
May 4, 2020
TristonianJones
added a commit
to rachelmyers/cel-go
that referenced
this pull request
Jun 15, 2020
…oogle#345) * Fix the doc comments referring to the extant ClearBuiltins() option * Remove missed reference, fix typo
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Doc comments have been updated, but no additional godoc level
Exampletests have been added yet because I'd like the example to be meaningful and most of the tests around custom environments are toy examples.When #290 is implemented, I can easily see the
NewCustomEnvwarranting its own example as it will be much easier to subset CEL. Comment added to the FR #290 to this effect.Closes #344