docs: Document client Description types #1307
Merged
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
I am refraining from talking about immutability and local-global here, as that is a messy topic for which IMO we cannot clearly and definatively state our long-term plans.
Litterally nothing references this, and as it is public I think we should remove it
It looks out of date, and is either way untidy for us and for users.
AndrewSisley
added
documentation
fredcarle
approved these changes
Apr 6, 2023
client/descriptions.go
Outdated
| ID uint32 | ||
| // Name contains the name of the collection. | ||
| // | ||
| // It is conceptually local to node hosting the DefraDB instance, but currently there |
There was a problem hiding this comment.
Suggested change
| // It is conceptually local to node hosting the DefraDB instance, but currently there | |
| // It is conceptually local to the node hosting the DefraDB instance, but currently there |
There was a problem hiding this comment.
cheers 😁
- add missing 'the'
Benchmark ResultsSummary
✅ See Better Results...
❌ See Worse Results...
✨ See Unchanged Results...
🐋 See Full Results... |
|||||||||||||||
AndrewSisley
added
the
action/no-benchmark
shahzadlone
pushed a commit
that referenced
this pull request
Apr 13, 2023
* Document CollectionDescription.Name * Document CollectionDescription.ID * Document CollectionDescription.Schema I am refraining from talking about immutability and local-global here, as that is a messy topic for which IMO we cannot clearly and definatively state our long-term plans. * Remove unused IndexDescription type Litterally nothing references this, and as it is public I think we should remove it * Document SchemaDescription.Name * Document SchemaDescription.Fields * Document FieldDescription.Name * Document FieldDescription.ID * Expand FieldDescription.Kind documentation * Document FieldDescription.Schema * Document FieldDescription.RelationName * Expand documentation for FieldDescription.Typ * Document FieldDescription.RelationType * Remove out of date comment It looks out of date, and is either way untidy for us and for users.
shahzadlone
pushed a commit
to shahzadlone/defradb
that referenced
this pull request
Feb 23, 2024
* Document CollectionDescription.Name * Document CollectionDescription.ID * Document CollectionDescription.Schema I am refraining from talking about immutability and local-global here, as that is a messy topic for which IMO we cannot clearly and definatively state our long-term plans. * Remove unused IndexDescription type Litterally nothing references this, and as it is public I think we should remove it * Document SchemaDescription.Name * Document SchemaDescription.Fields * Document FieldDescription.Name * Document FieldDescription.ID * Expand FieldDescription.Kind documentation * Document FieldDescription.Schema * Document FieldDescription.RelationName * Expand documentation for FieldDescription.Typ * Document FieldDescription.RelationType * Remove out of date comment It looks out of date, and is either way untidy for us and for users.
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.
Relevant issue(s)
Resolves #1306
Description
Documents the client Description types and removes some dead code.
Following this PR the only real other totally undocumented stuff in client is the Document related stuff, and that is quite dirty and in need of a rework I think soon anyway, I also see it as less important at the moment, so I wont go over it for 0.5.