docs(codegen): fix .gitignore example to show target attribution comment#59
Merged
Conversation
The heph-managed .gitignore block pairs each pattern with a `# //pkg:target` comment naming the emitting target, rendered on its own line above the pattern (hephbuild/heph#143). Update the example to match real output.
⚡ Cloudflare Pages preview
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Triggered by hephbuild/heph#143 (commit
9a482a9), which fixed a bug inheph tool gen-gitignore: the managed.gitignoreblock now pairs each pattern with a# //pkg:targetattribution comment on its own line above the pattern, instead of the old (broken) trailingpattern # //pkg:targetform — git only treats#as a comment when it starts the line, so the old inline form was a literal, non-matching pattern.I confirmed against
hephbuild/hephmaster that every entry produced by a freshheph tool gen-gitignorescan always carries this attribution comment (Engine::codegen_copy_gitignore_patternsincrates/engine/src/engine/gitignore.rsunconditionally setsaddr: Some(addr.clone())), so the example inwebsite/docs/concepts/codegen.md— which previously showed only a bare pattern line with no attribution — didn't reflect real output either before or after this fix..gitignoreexample in the "Keeping.gitignorein sync" section to show the# //fmt:generatedattribution line above/fmt/generated.txt, matching the target name already used elsewhere in the same doc's examples.plugins/heph-expert/skills/heph/references/*.md,plugins/heph-go/skills/heph-go/references/*.md) contain a rendered.gitignoreexample, so no further changes were needed there.Test plan
🤖 Generated with Claude Code
Generated by Claude Code