Skip to content

Add a CI check to keep stdlib.json in sync with library - #75

Merged
Hrom131 merged 1 commit into
BlockstreamResearch:devfrom
schoen:ci-check-stdlib-json
Oct 29, 2026
Merged

Hrom131 merged 1 commit into
BlockstreamResearch:devfrom
schoen:ci-check-stdlib-json

Conversation

@schoen

@schoen schoen commented Oct 29, 2026

Copy link
Copy Markdown
Contributor
  • This PR suggests a bug fix and I've added the necessary tests.
  • This PR introduces a new feature and I've discussed the update in an Issue or with the team.
  • This PR is just a minor change like a typo fix.

Add a GitHub CI action and corresponding Python script to check that there are no differences between the list of functions that are documented in docs/stdlib.json and the list of functions that are defined in source files under simf/lib. (Of course, this doesn't guarantee that the documentation is correct, only that every function is documented in some way and every documented function exists.)

@schoen schoen changed the title Add a workflow and script to check docs/code sync Add a CI check to keep stdlib.json in sync with library Oct 29, 2026

@Hrom131 Hrom131 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM!

@Hrom131
Hrom131 merged commit f9e5370 into BlockstreamResearch:dev Oct 29, 2026
6 checks passed
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.

2 participants