Skip to content

Docs: Verify MuscleGroup constructor signature #57

@kluth

Description

@kluth

Problem

MuscleGroup constructor usage in examples needs verification against actual implementation.

Affected Files

Documentation: /home/matthias/projects/synapse/docs/systems/SYSTEMS_OVERVIEW.md (lines 160-165)
Source Code: /home/matthias/projects/synapse/src/muscular/core/MuscleGroup.ts

Issue Details

Severity: MEDIUM
Impact: Code example may not compile/run

Example Requiring Verification

const pipeline = new MuscleGroup('csv-pipeline', [
  parseCSV,
  new FilterMuscle(validateRow),
  new MapMuscle(transformRow),
]);

const users = await pipeline.execute(csvData);

Verification Tasks

  1. Check MuscleGroup constructor signature
  2. Verify parameter order and types
  3. Confirm FilterMuscle and MapMuscle constructor usage
  4. Verify execute() method signature
  5. Update documentation if discrepancies found

Priority

MEDIUM - Code verification needed

References

User Story

As a developer, I want correct MuscleGroup usage examples, so that I can build data processing pipelines without trial-and-error.

Acceptance Criteria

  • Verify MuscleGroup constructor parameters
  • Verify Muscle instantiation patterns
  • Update example if needed
  • Test that example code works

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentationmediumMedium priority - fix next sprint

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions