Document the flat-file dataset format - #536
Merged
Merged
Conversation
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
1 participant
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.
Fixes #263
Summary
Dataset.FLAT_FILEalongside the other supportedDataset.data_formatvalues.Validation
uv run --no-sync ruff format policyengine_core/data/dataset.pyuv run --no-sync ruff check policyengine_core/data/dataset.pyuv run --no-sync towncrier build --draft --version 3.32.1uv run --no-sync make documentation— succeeded with 25 pre-existing warningsgit diff --checkThe checks use the existing development environment without synchronizing because the automated 3.32.0 release commit updated the package version while the lockfile's root-package record remains at 3.31.1. This pull request does not alter dependency resolution.
Documentation review
The
Dataset.data_formatsource documentation now describes all four accepted formats. No runtime behavior or separate usage-guide changes are required for this narrowly scoped correction. Impact is low and confidence is high. The generated API page displays the class attributes but, as before, does not render any of their adjacent attribute-description strings; this pull request preserves the documentation pattern requested by the issue rather than changing the documentation configuration.