Skip to content

fix: formatting adjustments for docs and Makefile - #1107

Merged
mbevc1 merged 2 commits into
mainfrom
20260819_minor_fixes
Aug 19, 2026
Merged

fix: formatting adjustments for docs and Makefile#1107
mbevc1 merged 2 commits into
mainfrom
20260819_minor_fixes

Conversation

@mbevc1

@mbevc1 mbevc1 commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Minor formatting and cosmetic fixes for Makefile help output and docs for create custom-attestation-type. Also clean up trailing spaces. No user facing changes.

Checklist

@mbevc1 mbevc1 added documentation Improvements or additions to documentation fix labels Aug 19, 2026
@claude

claude Bot commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Claude finished @mbevc1's task in 1m 32s —— View job


Claude Review

  • Gather context (read diff & changed files)
  • Static analysis (build, vet)
  • Review changes
  • Post feedback

This is a clean, well-scoped docs/cosmetic PR. No user-facing behaviour changes.

Static analysis

  • go build ./cmd/kosli/ — passes
  • go vet ./cmd/kosli/ — passes

Findings

  • Previous review nit resolved. The earlier comment about the unwrapped jq-format is now addressed — line 29 reads given in ^jq^-format. A grep across the file confirms every prose reference to jq in the help/example text is now consistently wrapped in ^jq^ (lines 29, 35, 38, 44, 51). The remaining bare jq occurrences are actual CLI flags (--jq) or Go identifiers, which is correct.

  • Trailing-whitespace cleanup. The old text used two-trailing-spaces (Markdown hard line breaks) which rendered inconsistently; removing them and relying on real newlines is a sensible tidy-up. Rendering is unchanged for the help output.

  • Makefile column width (%-15s%-21s). This is the right value: the longest help target is test_integration_full at exactly 21 characters, so the previous %-15s left longer targets (test_integration, suggest-version-ai, test_integration_full) with misaligned descriptions. The new width aligns all current targets. Minor note: if a longer ##-documented target is added later, this constant would need bumping again — but that's inherent to the fixed-width approach and fine for now.

Testability / tests: Not applicable — pure documentation/help-text and Makefile formatting; no logic changed, so no new tests are warranted.

Summary: Looks good to merge. 👍 Nice attention to consistency (wrapping every jq reference) and to the Makefile alignment math.
· 20260819_minor_fixes

Comment thread cmd/kosli/createAttestationType.go Outdated
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
@mbevc1
mbevc1 enabled auto-merge (squash) August 19, 2026 15:00
@mbevc1
mbevc1 merged commit 4313b08 into main Aug 19, 2026
27 of 28 checks passed
@mbevc1
mbevc1 deleted the 20260819_minor_fixes branch August 19, 2026 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation fix

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants