Skip to content

Code quality: Typos in IPipelineEncoding documentation - 'convering' should be 'converting' #1638

Description

@thomhurst

Issue

The IPipelineEncoding interface has typos in the XML documentation where "convering" should be "converting".

Location

  • File: src/ModularPipelines/Context/IPipelineEncoding.cs
  • Lines: 20 and 25

Current Code

/// <summary>
/// Gets helpers for convering XML.  // <-- typo
/// </summary>
IXml Xml { get; }

/// <summary>
/// Gets helpers for convering YAML.  // <-- typo
/// </summary>
IYaml Yaml { get; }

Note

Line 16 correctly uses "converting" for the JSON property:

/// <summary>
/// Gets helpers for converting JSON.  // <-- correct
/// </summary>
IJson Json { get; }

Suggested Fix

/// <summary>
/// Gets helpers for converting XML.
/// </summary>
IXml Xml { get; }

/// <summary>
/// Gets helpers for converting YAML.
/// </summary>
IYaml Yaml { get; }

Why This Matters

Documentation typos affect professional perception and create inconsistency within the same interface.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions