google/flatbuffers

FR: Add an example of a vector of unions to the tutorial

Open

#6828 opened on Sep 1, 2021

View on GitHub
 (4 comments) (0 reactions) (0 assignees)C++ (25,952 stars) (3,564 forks)batch import
documentationhelp wantednot-stale

Description

Right now there's little documentation about how to handle a vector of unions. I know this isn't supported in all languages, but it would be very helpful to have this for the languages that do support it.

Contributor guide

Tech stack
cpp
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Understanding FlatBuffers schemaFamiliarity with FlatBuffers tutorial
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Check the existing FlatBuffers tutorial documentation (likely in the docs/ directory). Identify which languages support vectors of unions (e.g., C++, TypeScript). Then add an example demonstrating vector of unions in the appropriate tutorial sections for each language.