[Task]: Make pydoc docstring reflecting deprecated and experimental API

[Abacn]

What needs to happen?

When @deprecated() and @experimental() decorators are used, it may be possible to also alter docstring (__doc__) so that it is reflected in autogenerated sphinx docs. Similar to that TF is doing this here: https://github.com/tensorflow/tensorflow/blob/e4dbcc5732be1914b5dad205c2b1eabc040aafc4/tensorflow/python/util/deprecation.py#L372

Issue Priority

Priority: 2

Issue Component

Component: sdk-py-core

[Abacn]

.add-labels website
.remove-labels core, 'awaiting triage'

[github-actions]

Label website
.remove-labels cannot be managed because it does not exist in the repo. Please check your spelling.

[tvalentyn]

.remove-labels cannot be managed because it does not exist in the repo. Please check your spelling.

@damccorm do you know the right command by chance?

[github-actions]

Label cannot cannot be managed because it does not exist in the repo. Please check your spelling.

[damccorm]

Hm, I think the bot doesn't handle new lines correctly. Moving it to one line will probably resolve it? I'll check:

.add-labels website .remove-labels core,'awaiting triage'

[damccorm]

(to be clear, this is a bug that should be fixed)

[damccorm]

Oh, there may also be an ordering issue with multiple commands? Idk, I'll look into it, I filed #22269

.add-labels website

[tvalentyn]

.add-labels website

[tvalentyn]

I see. thanks for looking into it!

[Abacn]

.add-labels "good first issue"

[github-actions]

Label "good cannot be managed because it does not exist in the repo. Please check your spelling.

[Abacn]

.add-labels good_first_issue

[github-actions]

Label good_first_issue cannot be managed because it does not exist in the repo. Please check your spelling.

[Abacn]

.add-labels 'good first issue'