docs: document heph.fs provider functions and fix inspect functions output#24
Merged
Merged
Conversation
…utput format hephbuild/heph#57 added declarative typed signatures to provider-exposed BUILD functions and changed `heph inspect functions` output to include the full signature (e.g. `fs.glob(pattern: string) -> list[string]`). - inspecting-builds.md: fix description of `heph inspect functions` output (was `heph.<provider>.<fn>`, now `<provider>.<signature>`) - plugins/fs.md: add "Provider functions" section documenting the four `heph.fs.*` BUILD-callable helpers (glob, join, dir, base) with typed signatures and a note distinguishing `heph.fs.glob` from the `glob()` builtin - heph-expert/references/authoring.md: reference-drift update — add `heph.fs` section alongside the existing `heph.core` section https://claude.ai/code/session_014wucdKDQxMSWeSNXvR3wSs
⚡ Cloudflare Pages preview
|
Member
Author
|
Add a provider function for go plugin too |
…h.go.build_addr Per review on #24. Matches the pattern added for the fs plugin — a dedicated "Provider functions" section listing the function with its enforced typed signature. Updates the heph-go reference too (reference drift rule). https://claude.ai/code/session_014wucdKDQxMSWeSNXvR3wSs
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
2 participants
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.
$(cat <<'EOF'
Summary
Follow-up docs for hephbuild/heph#57 (enforce declarative signatures on provider functions).
guides/inspecting-builds.md: Fix the description ofheph inspect functions— the output format changed fromheph.<provider>.<fn>to<provider>.<signature>(e.g.fs.glob(pattern: string) -> list[string]).plugins/fs.md: Add a "Provider functions" section documenting the fourheph.fs.*BUILD-callable helpers (glob,join,dir,base) with their typed signatures. Includes a note distinguishingheph.fs.glob(returnslist[string]of path strings) from the top-levelglob()builtin (returns a filesystem target address).heph-expert/references/authoring.md: Reference-drift update — add aheph.fssection alongsideheph.coreso the plugin reference stays current.Test plan
heph.fssection infs.mdmatches actual signatures from the codeinspect functionsexample output matches new formathttps://claude.ai/code/session_014wucdKDQxMSWeSNXvR3wSs
EOF
)
Generated by Claude Code