golang/go

encoding/xml: document why round-trip stability is not guaranteed

Open

#44,405 opened on Feb 19, 2021

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Go (19,008 forks)batch import
DocumentationNeedsInvestigationhelp wanted

Repository metrics

Stars
 (133,883 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

It is extremely non-obvious why encoding/xml does not guarantee round-trip stability. The package documentation should explain why that is the case, when this is a problem, and what users should do instead.

Contributor guide

Research direction
Investigate the encoding/xml package internals to understand the reasons for non round trip stability and propose documentation.
Tech stack
go
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80