docs: refresh README/docs, add CHANGELOG, bump to v0.1.2#25
Merged
Conversation
- Update install instructions to the registered form (Pkg.add("DatabentoBinaryEncoding"))
across README, installation, quickstart, and troubleshooting; the package is
now in the General registry.
- Correct the enum reference lists in docs/src/api/enums.md to match src/types.jl:
full Schema set (CBBO/CMBP/TCBBO/BBO/MIX), full SType set incl. the new UNDEF
sentinel, and the real InstrumentClass members (CALL/PUT/STOCK/... codes).
- README features: note consolidated/BBO schemas and v3-tolerant live control records.
- Fix leftover old-name references (DBN -> DatabentoBinaryEncoding) in docs/benchmark.
- Add CHANGELOG.md (Keep a Changelog) covering v0.1.0 - v0.1.2.
- Bump version to 0.1.2.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Comments on pull requests will not trigger Registrator, as it is disabled. Please try commenting on a commit or issue. |
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
Documentation refresh that brings the docs in line with the current code, adds a
changelog, and bumps the version to 0.1.2 for release.
Changes
Pkg.add("DatabentoBinaryEncoding")across
README.md,docs/src/installation.md,docs/src/quickstart.md, anddocs/src/troubleshooting.md(the package is now in the General registry). TheGitHub URL is kept as the "unreleased changes" path.
docs/src/api/enums.md) — correct the hand-maintained liststo match
src/types.jl:Schema: addCBBO,CBBO_1S/1M,CMBP_1,TCBBO,BBO_1S/1M,MIX.SType: list the full member set including the newUNDEF(0xFFunset sentinel).InstrumentClass: replace the incorrectOPTION/FX_SPOT-only list with thereal members and their DBN character codes (
CALL='C',PUT='P',STOCK='K', …).control records.
DBN→DatabentoBinaryEncodingreferences indocs/src/installation.md,docs/src/troubleshooting.md, andbenchmark/README.md.covering v0.1.0 → v0.1.2.
version = "0.1.2".Release
After merge,
@JuliaRegistrator registerwill be triggered on the merge commit;TagBot creates the
v0.1.2tag automatically once the registry PR merges.Docs-only + version bump — no source changes.
🤖 Generated with Claude Code