Skip to content

Commit 1a719ca

Browse files
authored
add FAQ section to README with an exlanation of the "list of single-entry dictionaries" pattern (#290)
1 parent 52e9f73 commit 1a719ca

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

.github/workflows/tests+pypi.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,8 @@ jobs:
193193
needs: [build]
194194
steps:
195195
- uses: actions/setup-python@v2
196+
with:
197+
python-version: "3.11"
196198
- run: pip install twine auditwheel
197199
- uses: actions/download-artifact@v2
198200
with:

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,11 @@ flowchart TD
209209
style PartMC fill:#7ae7ff,stroke-width:2px,color:#2B2B2B
210210
```
211211

212+
## FAQ
213+
214+
- Q: Why some of the constructors expect data to be passed as **lists of single-entry dictionaries** instead of multi-element dictionaries?
215+
A: This is intentional and related with PartMC relying on the order of elements within spec-file input; while Python dictionaries preserve ordering (insertion order), JSON format does not, and we intend to make these data structures safe to be [de]serialized using JSON.
216+
212217
## Troubleshooting
213218

214219
#### Common installation issues

0 commit comments

Comments
 (0)