Skip to content

docs: fix three inaccuracies in PLUGIN_DEVELOPMENT.md code examples #141

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.

Sign up for GitHub

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

Merged
intel352 merged 2 commits into from
Feb 23, 2026
Merged

docs: fix three inaccuracies in PLUGIN_DEVELOPMENT.md code examples #141

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e59e341
Initial plan
Copilot Feb 23, 2026
ff95b7c
docs: fix PipelineStep signature, add slog import, and handle LoadPlu…
Copilot Feb 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/PLUGIN_DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ The returned value must implement `module.PipelineStep`:
```go
type PipelineStep interface {
Name() string
Execute(ctx context.Context, pc *PipelineContext) error
Execute(ctx context.Context, pc *PipelineContext) (*StepResult, error)
}
```

Expand Down Expand Up @@ -349,6 +349,7 @@ This enables workflows to fail fast with actionable errors rather than cryptic r
package myplugin

import (
"log/slog"
"testing"

"github.com/CrisisTextLine/modular"
Expand All @@ -368,7 +369,9 @@ func TestPluginLoads(t *testing.T) {
func TestModuleCreation(t *testing.T) {
app := modular.NewStdApplication(modular.NewStdConfigProvider(nil), nil)
engine := workflow.NewStdEngine(app, slog.Default())
engine.LoadPlugin(New())
if err := engine.LoadPlugin(New()); err != nil {
t.Fatalf("LoadPlugin failed: %v", err)
}

cfg := &config.WorkflowConfig{
Modules: []config.ModuleConfig{
Expand Down