Repository navigation
Label the dot-path document update as eppy compatibility - #37
Merged
Merged
Conversation
The "Batch updates" section presented IDFDocument.update, which takes "Type.Name.field" keys, as idfkit's own way to edit several fields. It is part of the excluded eppy compatibility surface. The section now says so and follows it with the native form, which fetches the object once and assigns its fields. The comparison table shows the native form in the idfkit column and keeps doc.update(d) in the eppy alias column. idfkit-unification feature 015, FR-016.
Contributor
|
Docs preview for this PR is available at: Changed pages: |
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.
Summary
The migration guide's "Batch updates" section presented
IDFDocument.update({"Zone.Office.x_origin": 10.0})as idfkit's own way to edit several fields. That method is part of the eppy compatibility surface, which the naming register excludes. This change:docs/snippets/migration/batch_updates_3.py);doc.update(d)in the "eppy alias in idfkit?" column, with the footnote updated to match.No other prose is changed. When
IDFObject.updateships (idfkit/idfkit#235), the native form will be revised to use it.Checks
make check: passed, including the type check of the new snippet.make docs-test: the strict build reports 113 warnings locally, all of themcairosvgfailing to load the system cairo library for social cards. Excluding those, the build reports no warnings, and the migration page renders both snippets.