-
Notifications
You must be signed in to change notification settings - Fork 304
document packages #2316
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
document packages #2316
Conversation
72e4444
to
da4e2dd
Compare
da4e2dd
to
b630311
Compare
@@ -1,3 +1,4 @@ | |||
// Package developmentmembership defines operations with sets. To be used in tests only. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I hope i got this right... developmentmembership
wasn't a clear name 😅
b630311
to
5854f58
Compare
f3b55ae
to
3593d01
Compare
3593d01
to
7c965ca
Compare
7c965ca
to
a416199
Compare
a416199
to
d09562a
Compare
d09562a
to
a289b62
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, see comments
@@ -44,7 +44,7 @@ func (ss SubjectSet) UnionWithSet(other SubjectSet) error { | |||
return ss.BaseSubjectSet.UnionWithSet(other.BaseSubjectSet) | |||
} | |||
|
|||
// WithParentCaveatExpression returns a copy of the subject set with the parent caveat expression applied | |||
// WithParentCaveatExpression returns a copy of the subject set with the parent caveat expression applied |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nbsp?
@@ -0,0 +1,2 @@ | |||
// Package servicespecific defines middleware that injects other middlewares. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
// Package servicespecific defines middleware that injects other middlewares. | |
// Package servicespecific defines middleware that injects other middlewares for service-specific use cases. |
// Package development contains code that runs in the Playground. | ||
package development |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is also used by zed
. Maybe "used by other libraries to facilitate schema development?"
I glazed over the code to see what is implemented and to get a feeling of the overall organization. (And I fixed some typos along the way)
What stood out to me is that there are lot of folders with the same name within
internal
and withinpkg
. The line of what goes where seems blurry. E.g.:graph
(only 2 files inpkg
?)caveats
. And, surprisingly, differentEvaluation Results
structs exist in both foldersnamespace
/schema
I believe that this could be simplified by merging folders, but this could break existing consumers of
pkg
if we move tointernal
. Who are the code consumers ofpkg
today? Do we provide guarantees on its stability?Other things I noticed:
I'd be happy to submit follow-up PRs for all these things 😄