Repository navigation
Document the completed petrolib library in README and a new docs/ folder - #163
Merged
Merged
Conversation
- README: the "migration in progress" section becomes a completed "Common library (petrolib)" section with the domain list, doc links, and the docstring-citation note; the repository-layout tree gains the petrolib/, docs/, tests/, and tools/ entries plus the missing src2026_06 line; the Usage section gains src2026_06 runners and a direct petrolib usage example (snippets verified by running them). - docs/petrolib.md: guide to the library - design principles (strangler-fig facades, bit-exact adoption, bare-clone invariant, numpy-only core, corpus-grounded APIs), installation, module map, provenance/citations, testing gates, and migration history pointers. - docs/petrolib-api.md: generated API reference - every public function, class, and constant across the 40 petrolib modules with one-line summaries from the docstrings. - tools/gen_petrolib_api.py: the generator (constants pick up their "#:" doc comments), so the reference can be regenerated after any petrolib change. ruff check/format clean; 259 tests pass (petrolib + golden tools). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01B2BX1XL8422gebCU1oVoQC
ingehap
marked this pull request as ready for review
July 10, 2026 10:48
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.
Summary
Updates the repository documentation to reflect the completed
petroliblibrary (merge plan finished in #160/#161, docstring citations in #162).README.md
petrolib) — migration in progress" section becomes a completed Common library (petrolib) section: the domain list, links to the new docs, the numpy-only-core note, and the docstring-citation note. The bare-clone and test-harness bullets stay.petrolib/,docs/,tests/, andtools/entries, plus the previously missingsrc2026_06line (Vol. 67 No. 3, 10 modules).src2026_06script/test-runner entries and a short direct-petrolib example (all snippets verified by running them).docs/ (new folder)
docs/petrolib.md— the library guide: what petrolib is and where it came from; the design principles (strangler-fig facades, bit-exact adoption, bare-clone invariant, numpy-only core with lazy scipy, corpus-grounded APIs); installation and quick-start; a domain-level module map; the provenance/citation scheme (Sources:tags + per-module References sections); the testing and regression gates; and pointers to LIBRARY_MERGE_PLAN.md for the full history.docs/petrolib-api.md— a generated API reference: every public function, class, and constant across the 40 petrolib modules with one-line summaries pulled from the docstrings (648 API rows), with a linked table of contents.tools/gen_petrolib_api.py — the generator behind the API reference (AST-based; function signatures, class method lists, and constants with their
#:doc comments), so the reference can be regenerated with one command after any petrolib change.Verification
ruff check+ruff format --checkclean on the new tool;python3 -m pytest tests/petrolib tests/test_golden_tools.py: 259 passed.🤖 Generated with Claude Code
https://claude.ai/code/session_01B2BX1XL8422gebCU1oVoQC
Generated by Claude Code