Repository navigation
Add missing godoc comments to compiler functions #14495
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,17 @@ | ||
| // Package workflow implements workflow compilation orchestration. | ||
| // | ||
| // The compiler orchestrator is split into 5 focused modules for maintainability: | ||
| // | ||
| // - orchestrator.go: Shared logger and constants used across orchestrator modules | ||
| // - orchestrator_engine.go: Engine detection, validation, and setup logic | ||
| // - orchestrator_frontmatter.go: Frontmatter parsing and validation | ||
| // - orchestrator_tools.go: Tool configuration and MCP server setup | ||
| // - orchestrator_workflow.go: Main workflow orchestration and YAML generation | ||
| // | ||
| // The orchestrator follows a phased approach with typed result structures | ||
| // for clear data flow between compilation stages. Each module handles a specific | ||
| // concern in the compilation pipeline, making the codebase easier to understand | ||
| // and maintain. | ||
|
Comment on lines
+1
to
+14
|
||
| package workflow | ||
|
|
||
| import ( | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The docstring says this function "Returns the compiled workflow data or an error", but the signature returns only
error. This is misleading ingo docoutput; adjust the comment to describe that it compiles and writes the lock YAML (and returns an error on failure).This issue also appears on line 434 of the same file.