Skip to content

Add missing docs for binary and build_args attributes - #434

Merged
lalten merged 1 commit into
mainfrom
copilot/add-docs-for-binary-and-build-args
Aug 2, 2026
Merged

Add missing docs for binary and build_args attributes#434
lalten merged 1 commit into
mainfrom
copilot/add-docs-for-binary-and-build-args

Conversation

Copilot AI commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

The binary and build_args attributes of the appimage/appimage_test rules had no doc string, causing docs/defs.md to render them as a literal -.

Changes

  • Added concise doc strings with examples to the binary and build_args attrs in appimage/appimage.bzl
  • Regenerated docs/defs.md to reflect the new attribute descriptions
"binary": attr.label(executable = True, cfg = "target", doc = "The executable that is packaged and run inside the appimage, e.g. `//path/to:my_binary`"),
"build_args": attr.string_list(doc = "Extra arguments passed to `mksquashfs` when building the appimage, e.g. `['-comp', 'xz']`"),

@lalten
lalten marked this pull request as ready for review August 2, 2026 08:51
Copilot AI review requested due to automatic review settings August 2, 2026 08:51
@lalten
lalten merged commit 9733882 into main Aug 2, 2026
19 checks passed
@lalten
lalten deleted the copilot/add-docs-for-binary-and-build-args branch August 2, 2026 08:52

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves the generated Stardoc documentation for the appimage and appimage_test Bazel rules by adding missing attribute documentation for binary and build_args, so docs/defs.md no longer renders these fields with a placeholder -.

Changes:

  • Added doc strings (with brief examples) to the binary and build_args attributes in appimage/appimage.bzl.
  • Regenerated docs/defs.md so the published rule documentation reflects the new attribute descriptions.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
appimage/appimage.bzl Adds missing doc strings for binary and build_args attributes used by appimage/appimage_test.
docs/defs.md Updates generated docs output to include the new attribute descriptions instead of -.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants