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

Document Engine sub-type in kv module as a part of doc quest #8546

Closed
palash25 opened this issue Aug 28, 2020 · 3 comments · Fixed by #8604
Closed

Document Engine sub-type in kv module as a part of doc quest #8546

palash25 opened this issue Aug 28, 2020 · 3 comments · Fixed by #8604
Labels
component/documentation Component: Documentation component/storage Component: Storage, Scheduler, etc. contribution Type: PR - From contributors

Comments

@palash25
Copy link
Contributor

Related to: tikv/sig-transaction#25

Hi I would like to try documenting Engine as a part of the doc quest.

@nrc can you please add this issue link to the parent issue in the sig-transaction repo

@nrc nrc added contribution Type: PR - From contributors component/documentation Component: Documentation component/storage Component: Storage, Scheduler, etc. labels Aug 29, 2020
@nrc
Copy link
Contributor

nrc commented Aug 29, 2020

Awesome!

cc @brson who has le the work on the Engine trait.

@palash25
Copy link
Contributor Author

palash25 commented Sep 6, 2020

I had a question regarding this, does documenting the methods under Engine trait also come under the scope of this issue or is it just the comments on top of the trait, because if it is the latter, I can't really think of much to document

@nrc
Copy link
Contributor

nrc commented Sep 7, 2020

It would be good to document the methods. As you say, there is not a lot to say about the trait itself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component/documentation Component: Documentation component/storage Component: Storage, Scheduler, etc. contribution Type: PR - From contributors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants