pickle.__doc__ does not describe custom pickling

[marnanel]

Documentation

pickle.doc doesn't describe how __getstate__ and __setstate__ can be used for custom pickling, although this is an important part of how the module works.

Split from #138676 which attempted to cover both issues; copy.__doc__ claims that pickle.__doc__ explains this, and it doesn't.

[AA-Turner]

copy.__doc__ claims that pickle.__doc__ explains this, and it doesn't.

I don't think this is true, the copy docstring instructs you to consult the documentation, which does.

Attempting to cover this in __doc__ would be needlessly verbose and a worse resource than the documentation.

A

[marnanel]

copy.__doc__ claims that pickle.__doc__ explains this, and it doesn't.

I don't think this is true, the copy docstring instructs you to consult the documentation, which does.

Fair enough. Maybe it should put it more explicitly: I assumed it meant __doc__ (of course, otherwise I wouldn't have raised the bug).

[picnixz]

I think it would be overly verbose and changing this specific instance would mean changing it everywhere else and distinguish between __doc__ and docs.python.org, which again would not be desirable. Sorry but I'm closing this as not planned.