Document Serde attribute mapping - #998
Conversation
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #998 +/- ##
==========================================
- Coverage 57.31% 55.96% -1.35%
==========================================
Files 46 47 +1
Lines 18197 18375 +178
==========================================
- Hits 10429 10284 -145
- Misses 7768 8091 +323
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
7d45f9b to
4271dd1
Compare
|
Current head The PR remains mergeable and still changes only I still could not run |
|
As written in the contribution policy, please do not use agents to write comments. I expect this was unintentional, but nonetheless. |
| //! serialization and deserialization; see the [Serde mapping basics] for examples. | ||
| //! A flattened map can capture attributes whose names are not known in advance. | ||
| //! | ||
| //! [Serde mapping basics]: ../../de/index.html#basics |
There was a problem hiding this comment.
This doesn't feel like the appropriate place for this specific documentation. If this isn't already documented in src/de then it might make sense there. I presume it already is given the link.
There was a problem hiding this comment.
In other words, this ought to be removed.
There was a problem hiding this comment.
The discussion on the issue already mentions this, too. If it needs to be more visible, then please suggest somewhere that is more visible - but the core attributes docs isn't appropriate.
Closes #804
Clarifies that the Serde XML mapping applies to serialization as well as deserialization, and links both the serializer and event-attribute modules to the existing mapping guide. The attribute docs also point out named
@fields and flattened maps.Tests:
cargo fmt --all -- --checkcargo test --doc --all-features(149 passed, 5 ignored)git diff --checkAI assistance: OpenAI Codex helped prepare the documentation changes; I reviewed and verified the final diff.