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
Add some comments for Server re-org sample #155
Add some comments for Server re-org sample #155
Conversation
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.
Briefly discussed with Maria - not sure about these comments:
Looks like they are replicating a lot of the information that could be factored in the Asciidoc?
I'm also not sure who the comment is for? Is this the right abstraction level for the typical developer? If we comment anything, would it be the shape of e.g. result
or row
? An example JSON output or similar.
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.
Thanks @maria-robobug , this is great. I've just cut them down slightly to save space. As @osfameron says if further explanation is needed it can go in the AsciiDoc.
I would say, a developer who has a good knowledge of the language, and maybe some prior knowledge of traditional SQL, but is new to Couchbase and needs to know what are the methods, objects, or functions offered by the SDK. |
Sounds good, just have some minor questions:
|
Co-authored-by: Simon Dew <39966290+simon-dew@users.noreply.github.com>
Co-authored-by: Simon Dew <39966290+simon-dew@users.noreply.github.com>
I mean that these code snippets might be included anywhere. The including page should include the appropriate level of explanation. So in the docs server pages there might be more explanation; in the SDK pages there might be less. |
I'm updating couchbase/docs-server#2249 to include a one- or two-line explanation of these code snippets that is (hopefully) appropriate for the developer how-to guide. I'll add you as a reviewer when it's ready @maria-robobug |
No description provided.