Skip to content

Document and normalize the public Bash API#180

Merged
codeforester merged 1 commit into
mainfrom
documentation/171-20260716-complete-public-api-docs
Jul 16, 2026
Merged

Document and normalize the public Bash API#180
codeforester merged 1 commit into
mainfrom
documentation/171-20260716-complete-public-api-docs

Conversation

@codeforester

Copy link
Copy Markdown
Collaborator

Summary

  • document the complete public API for the stdlib and tighten signatures and
    status contracts across every module README
  • normalize private logging and Git implementation helpers to the
    double-underscore convention without changing public function names
  • correct the list-library test path and add validation that every module README
    documents an existing BATS suite
  • align top-level library summaries with the current canonical Git, GitHub, and
    repeatable argument APIs

Fixes #171

Validation

  • ./tests/validate.sh (301 BATS tests)
  • bats lib/bash/std/tests/lib_std.bats lib/bash/git/tests/lib_git.bats (187 tests, one environment skip)
  • shellcheck --severity=error on production, validation, and launcher files
  • public-function inventory checked against module READMEs
  • git diff --check

@codeforester
codeforester merged commit 411834c into main Jul 16, 2026
2 checks passed
@codeforester
codeforester deleted the documentation/171-20260716-complete-public-api-docs branch July 16, 2026 05:47
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.

Define and document the complete public API surface

1 participant