Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing reference documentation (Godoc) #54

Closed
broady opened this issue Aug 13, 2018 · 2 comments · Fixed by #104
Closed

Missing reference documentation (Godoc) #54

broady opened this issue Aug 13, 2018 · 2 comments · Fixed by #104
Labels
bug Something isn't working good first issue Good for newcomers

Comments

@broady
Copy link

broady commented Aug 13, 2018

Here's a list of important functions and types that don't have documentation, and probably should:

@broady
Copy link
Author

broady commented Aug 13, 2018

Oh, and in the types package, what is DynType? A lot of the others are fairly obvious, but this is all I can find on it:

var (
	// DynType singleton.
	DynType = NewTypeValue("dyn")
)

// IsDyn indicates whether the input ref.Value or ref.Type is equal to DynType.
func IsDyn(elem interface{}) bool {

@TristonianJones
Copy link
Collaborator

Thanks for the pointers. We're working on cleaning up the docs and proto usage over the next quarter.

The concept of dyn comes from the CEL specification. It's basically a keyword to indicate that a value has dynamic type and is useful during the type-unification logic in the checker

@TristonianJones TristonianJones added bug Something isn't working good first issue Good for newcomers labels Aug 14, 2018
@TristonianJones TristonianJones changed the title Quite a lot of missing reference documentation (Godoc) Missing reference documentation (Godoc) Aug 14, 2018
JimLarson added a commit that referenced this issue Oct 16, 2018
Add mandatory godoc comments to satisfy linter.
closes #54
@grantr grantr mentioned this issue Apr 10, 2019
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants