Skip to content

Document the Dijkstra placeholder in readCardanoGenesisConfig - #1387

Merged
palas merged 1 commit into
masterfrom
add-haddock-to-read-conf
Oct 22, 2026
Merged

palas merged 1 commit into
masterfrom
add-haddock-to-read-conf

Conversation

@palas

@palas palas commented Oct 21, 2026

Copy link
Copy Markdown
Contributor

Context

This is a followup of #1379. And a response to this review: #1379 (comment).

This PR replaces a comment in readCardanoGenesisConfig with a Haddock that explains the need for readCardanoGenesisConfig to 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

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated. See Running tests for more details
  • Self-reviewed the diff
  • Changelog fragment added in .changes/

@palas palas self-assigned this Oct 21, 2026
Copilot AI balanced review requested due to automatic review settings October 21, 2026 19:11

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 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
palas requested a review from a team as a code owner October 21, 2026 20:12
@palas
palas force-pushed the add-haddock-to-read-conf branch from 60f26ec to b63f5fe Compare October 21, 2026 21:33
@palas
palas added this pull request to the merge queue Oct 22, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Oct 22, 2026
@palas
palas added this pull request to the merge queue Oct 22, 2026
Merged via the queue into master with commit 7120df6 Oct 22, 2026
52 of 54 checks passed
@palas
palas deleted the add-haddock-to-read-conf branch October 22, 2026 23:28
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.

4 participants