ugorji / go

idiomatic codec and rpc lib for msgpack, cbor, json, etc. msgpack.org[Go]
MIT License
1.83k stars 294 forks source link

shorter doc comments for fully-deprecated (ignored) fields/methods #397

Closed extemporalgenome closed 8 months ago

extemporalgenome commented 1 year ago

Fully ignored fields and methods can have shorter documentation, since knowledge of what they did does not help users of the current library version. Longer comments can also mislead some readers into believing these fields/methods are still useful to consider: for example, reading the first few sentences and thinking "this is exactly what I need," without reading far enough to see the Deprecated note at the bottom.

Deprecated-yet-usable fields/methods were not changed.