Skip to content

Update docs: - #18

Merged
PabloPardoGarcia merged 3 commits into
mainfrom
docs/update-v0.2.5
Mar 20, 2026
Merged

PabloPardoGarcia merged 3 commits into
mainfrom
docs/update-v0.2.5

Conversation

@PabloPardoGarcia

@PabloPardoGarcia PabloPardoGarcia commented Mar 20, 2026 •

Copy link
Copy Markdown
Member

index.mdx

  • Fixed CLI command: glassgen generate → glassgen generate-data
  • Removed dead links to /configuration and /examples (those pages don't exist)

getting-started.mdx

  • Fixed CLI command to glassgen generate-data
  • Added generate() reference section documenting all three parameters (config, schema, sink) and the return type difference (dict vs generator)
  • Added generate_one() reference with example
  • Expanded generator config table to document bulk_size and the rps: 0 / rps > 2500 behavior
  • Documented num_records: -1 for infinite generation
  • Added a full Event Duplication section documenting event_options.duplication (this feature was mentioned in the feature list but had zero docs on how to use it)
  • Removed dead link to /examples

generators.mdx

  • Added three previously undocumented generators: $prefixed_id, $array, and $query_string
  • Fixed $price default range description (was implying ~99.99; actual defaults are 0.99–9999.99)
  • Clarified $float range behavior (unbounded, can be negative or very large)
  • Merged $uuid and $uuid4 descriptions — both produce UUID v4; they are identical

sinks/webhook.mdx

  • Removed false claim of "Automatic retries" — the sink makes one attempt per record with no retry logic
  • Removed "SSL certificate verification" from the configurable security features — it is always on and not configurable
  • Added a note that Content-Type: application/json is always injected automatically

sinks/custom.mdx

  • Clarified that publish_bulk() is what the engine calls, not publish()
  • Added explicit note that custom sinks must be passed via sink= parameter — they cannot be used via the config "sink" block

sinks/yield.mdx

  • Documented the return type difference: generate() returns a generator (not a dict) when using yield sink
  • Added a code example showing how to capture the response metadata (time_taken_ms, num_records) after iteration using StopIteration.value
  • Added infinite generation example with num_records: -1

  index.mdx

  - Fixed CLI command: glassgen generate → glassgen generate-data
  - Removed dead links to /configuration and /examples (those pages don't exist)

  getting-started.mdx

  - Fixed CLI command to glassgen generate-data
  - Added generate() reference section documenting all three parameters (config, schema, sink) and the return type difference (dict vs generator)
  - Added generate_one() reference with example
  - Expanded generator config table to document bulk_size and the rps: 0 / rps > 2500 behavior
  - Documented num_records: -1 for infinite generation
  - Added a full Event Duplication section documenting event_options.duplication (this feature was mentioned in the feature list but had zero docs on how to
  use it)
  - Removed dead link to /examples

  generators.mdx

  - Added three previously undocumented generators: $prefixed_id, $array, and $query_string
  - Fixed $price default range description (was implying ~99.99; actual defaults are 0.99–9999.99)
  - Clarified $float range behavior (unbounded, can be negative or very large)
  - Merged $uuid and $uuid4 descriptions — both produce UUID v4; they are identical

  sinks/webhook.mdx

  - Removed false claim of "Automatic retries" — the sink makes one attempt per record with no retry logic
  - Removed "SSL certificate verification" from the configurable security features — it is always on and not configurable
  - Added a note that Content-Type: application/json is always injected automatically

  sinks/custom.mdx

  - Clarified that publish_bulk() is what the engine calls, not publish()
  - Added explicit note that custom sinks must be passed via sink= parameter — they cannot be used via the config "sink" block

  sinks/yield.mdx

  - Documented the return type difference: generate() returns a generator (not a dict) when using yield sink
  - Added a code example showing how to capture the response metadata (time_taken_ms, num_records) after iteration using StopIteration.value
  - Added infinite generation example with num_records: -1
@vercel

vercel Bot commented Mar 20, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
glassgen Ready Ready Preview, Comment Mar 20, 2026 5:36pm

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

Coverage

Test Coverage Report
FileStmtsMissCoverMissing
__init__.py60100% 
config.py791186%104–106, 108–109, 111–113, 115, 125–126
interface.py601181%14–16, 40–44, 54, 65–66
generator
   __init__.py50100% 
   batch_controller.py39392%16, 21–22
   duplication.py641379%26, 34, 38–39, 41–43, 45–46, 48–50, 52
   generator.py671971%40, 53, 86–90, 92–97, 99–100, 102, 106–108
   generators.py1032476%61, 118, 147–149, 151–154, 156–157, 159–161, 163, 170, 172–173, 176, 188, 191, 205, 258, 263
schema
   __init__.py40100% 
   base.py70100% 
   schema.py92792%50, 66, 76–77, 106–107, 132
   user_schema.py16193%30
sinks
   __init__.py130100% 
   base.py90100% 
   csv_sink.py47197%41
   kafka_sink.py281353%20–23, 27–28, 33, 36–38, 43–44, 47
   webhook_sink.py260100% 
   yield_sink.py100100% 
TOTAL67510384% 

@github-actions

Copy link
Copy Markdown
Contributor

Coverage

Test Coverage Report
FileStmtsMissCoverMissing
__init__.py60100% 
config.py791186%104–106, 108–109, 111–113, 115, 125–126
interface.py601181%14–16, 40–44, 54, 65–66
generator
   __init__.py50100% 
   batch_controller.py39392%16, 21–22
   duplication.py641379%26, 34, 38–39, 41–43, 45–46, 48–50, 52
   generator.py671971%40, 53, 86–90, 92–97, 99–100, 102, 106–108
   generators.py1032476%61, 118, 147–149, 151–154, 156–157, 159–161, 163, 170, 172–173, 176, 188, 191, 205, 258, 263
schema
   __init__.py40100% 
   base.py70100% 
   schema.py92792%50, 66, 76–77, 106–107, 132
   user_schema.py16193%30
sinks
   __init__.py130100% 
   base.py90100% 
   csv_sink.py47197%41
   kafka_sink.py281353%20–23, 27–28, 33, 36–38, 43–44, 47
   webhook_sink.py260100% 
   yield_sink.py100100% 
TOTAL67510384% 

@PabloPardoGarcia PabloPardoGarcia added the documentation Improvements or additions to documentation label Mar 20, 2026
@PabloPardoGarcia
PabloPardoGarcia merged commit 843b417 into main Mar 20, 2026
7 checks passed

This branch was successfully deployed

1 active deployment
Preview — 843b417c Deployed Mar 20, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant