Skip to content

Expand converter documentation with registration methods and priority#137

Merged
xoofx merged 1 commit into
xoofx:mainfrom
fdcastel:feature/converter-registration-docs
Mar 29, 2026
Merged

Expand converter documentation with registration methods and priority#137
xoofx merged 1 commit into
xoofx:mainfrom
fdcastel:feature/converter-registration-docs

Conversation

@fdcastel
Copy link
Copy Markdown
Contributor

Motivation

The existing converter documentation covers the basics but doesn't explain:

  • The three registration methods and their priority
  • Converter factories for open generic / type-family scenarios
  • The CurrentKey context available to converters
  • A clear precedence summary

Changes

Rewrites site/docs/serialization/converters.md to cover:

  1. Registration methods — member-level attribute, options-level, type-level attribute with code examples
  2. Priority order — explicit ordering from highest (member attribute) to lowest (object converter)
  3. Converter factoriesYamlConverterFactory pattern with CanConvert/CreateConverter example
  4. CurrentKey context — how custom converters can access YamlReader.CurrentKey for context-dependent logic
  5. Precedence summary table — complete resolution chain including IParsable<T> fallback

Rewrite site/docs/serialization/converters.md to document:
- Three registration methods (member-level, options-level, type-level)
- Priority order for converter resolution
- Converter factory pattern with example
- CurrentKey context access for custom converters
- Precedence summary table including IParsable<T> fallback
@xoofx xoofx merged commit bc166ce into xoofx:main Mar 29, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants