tarantool / tarantool/doc

tntcxx: update examples

Open
#3,969 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

tntcxx
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Firstly, example Simple was reworked, so this section is not actual (several doclabels were deleted), we need to fix it.

Secondly, we have a couple of new examples. Example Sql shows how to use SQL queries in tntcxx, and Schemaless demonstrates a way to work with schema-less tuples. We shouldn't add them to the getting started page - it would be overwhelming, but, probably, we should create a separate section for tntcxx examples.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked getting started section on decoding and reading data, then compare it with the reworked Simple example and its current doclabels. Review the Sql and Schemaless examples to determine the appropriate separate tntcxx examples section; done means the outdated section is corrected and both new examples are documented without expanding getting started.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, sql
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.