Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.Sign up
GitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
encoding/gob: document gob format compatibility promise #13808
The docstring for the
However, the fact that gobs can be stored permanently is mentioned nowhere else in the package documentation, except for the linked blog post. (In fact, most of package refers to gobs as a data interchange format to be sent over the network, rather than as a format that is suitable for disk storage.)
Can the format compatibility promise be more explicit? Perhaps in the Overview section of the package documentation? Obviously, this promise can only be kept if custom GobEncoder and BinaryMarshaler implementations remain stable. However, a promise could be made for types that do not implement those interfaces.