Repository navigation
Document the Dijkstra placeholder in readCardanoGenesisConfig - #1387
Merged
Merged
Conversation
palas
requested review from
CarlosLopezDeLara,
Jimbo4350,
carbolymer,
disassembler and
erikd
as code owners
October 21, 2026 19:11
palas
force-pushed
the
add-haddock-to-read-conf
branch
from
October 21, 2026 19:12
f344b8d to
b63f5fe
Compare
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation matches the implementation, with no behavioral changes or unresolved findings.
No open issues 🎉
What changed in this PR
Documents why readCardanoGenesisConfig supplies a placeholder Dijkstra genesis when experimental hard forks are disabled.
Changes:
- Replaces an inline comment with Haddock explaining the placeholder and hard-fork behavior.
- Adds a documentation changelog fragment; no runtime or API changes.
| File | Description |
|---|---|
| cardano-api/src/Cardano/Api/LedgerState.hs | Documents Dijkstra placeholder behavior. |
| .changes/20261021_205127_cardano-api_palas_read_cardano_genesis_config_haddock.yml | Records the documentation update. |
Review effort: Balanced
palas
force-pushed
the
add-haddock-to-read-conf
branch
from
October 21, 2026 21:33
60f26ec to
b63f5fe
Compare
carbolymer
approved these changes
Oct 22, 2026
Jimbo4350
approved these changes
Oct 22, 2026
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
Oct 22, 2026
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
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.
Context
This is a followup of #1379. And a response to this review: #1379 (comment).
This PR replaces a comment in
readCardanoGenesisConfigwith a Haddock that explains the need forreadCardanoGenesisConfigto produce a placeholder Dijkstra configuration even when it is not read from disk and is not used.How to trust this PR
This PR only changes documentation. It is a matter of verifying whether what it said is true.
Checklist
.changes/