You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by GitBox <gi...@apache.org> on 2022/07/13 23:24:28 UTC
[GitHub] [beam] Abacn opened a new issue, #22265: [Task]: Make pydoc docstring reflecting deprecated and experimental API
Abacn opened a new issue, #22265:
URL: https://github.com/apache/beam/issues/22265
### 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
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] damccorm commented on issue #22265: [Task]: Make pydoc docstring reflecting deprecated and experimental API
Posted by GitBox <gi...@apache.org>.
damccorm commented on issue #22265:
URL: https://github.com/apache/beam/issues/22265#issuecomment-1184415379
(to be clear, this is a bug that should be fixed)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] damccorm commented on issue #22265: [Task]: Make pydoc docstring reflecting deprecated and experimental API
Posted by GitBox <gi...@apache.org>.
damccorm commented on issue #22265:
URL: https://github.com/apache/beam/issues/22265#issuecomment-1184417779
Oh, there may also be an ordering issue with multiple commands? Idk, I'll look into it, I filed #22269
.add-labels website
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] Abacn commented on issue #22265: [Task]: Make pydoc docstring reflecting deprecated and experimental API
Posted by GitBox <gi...@apache.org>.
Abacn commented on issue #22265:
URL: https://github.com/apache/beam/issues/22265#issuecomment-1204254490
.add-labels "good first issue"
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] github-actions[bot] commented on issue #22265: [Task]: Make pydoc docstring reflecting deprecated and experimental API
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on issue #22265:
URL: https://github.com/apache/beam/issues/22265#issuecomment-1184408445
Label cannot cannot be managed because it does not exist in the repo. Please check your spelling.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] github-actions[bot] commented on issue #22265: [Task]: Make pydoc docstring reflecting deprecated and experimental API
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on issue #22265:
URL: https://github.com/apache/beam/issues/22265#issuecomment-1204255002
Label "good cannot be managed because it does not exist in the repo. Please check your spelling.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] damccorm commented on issue #22265: [Task]: Make pydoc docstring reflecting deprecated and experimental API
Posted by GitBox <gi...@apache.org>.
damccorm commented on issue #22265:
URL: https://github.com/apache/beam/issues/22265#issuecomment-1184414928
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'
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] tvalentyn commented on issue #22265: [Task]: Make pydoc docstring reflecting deprecated and experimental API
Posted by GitBox <gi...@apache.org>.
tvalentyn commented on issue #22265:
URL: https://github.com/apache/beam/issues/22265#issuecomment-1184408157
> .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?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] github-actions[bot] commented on issue #22265: [Task]: Make pydoc docstring reflecting deprecated and experimental API
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on issue #22265:
URL: https://github.com/apache/beam/issues/22265#issuecomment-1204256239
Label good_first_issue cannot be managed because it does not exist in the repo. Please check your spelling.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] Abacn commented on issue #22265: [Task]: Make pydoc docstring reflecting deprecated and experimental API
Posted by GitBox <gi...@apache.org>.
Abacn commented on issue #22265:
URL: https://github.com/apache/beam/issues/22265#issuecomment-1204257336
.add-labels 'good first issue'
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] tvalentyn commented on issue #22265: [Task]: Make pydoc docstring reflecting deprecated and experimental API
Posted by GitBox <gi...@apache.org>.
tvalentyn commented on issue #22265:
URL: https://github.com/apache/beam/issues/22265#issuecomment-1184420574
I see. thanks for looking into it!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] Abacn commented on issue #22265: [Task]: Make pydoc docstring reflecting deprecated and experimental API
Posted by GitBox <gi...@apache.org>.
Abacn commented on issue #22265:
URL: https://github.com/apache/beam/issues/22265#issuecomment-1183937912
.add-labels website
.remove-labels core, 'awaiting triage'
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] github-actions[bot] commented on issue #22265: [Task]: Make pydoc docstring reflecting deprecated and experimental API
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on issue #22265:
URL: https://github.com/apache/beam/issues/22265#issuecomment-1183945047
Label website
.remove-labels cannot be managed because it does not exist in the repo. Please check your spelling.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] tvalentyn commented on issue #22265: [Task]: Make pydoc docstring reflecting deprecated and experimental API
Posted by GitBox <gi...@apache.org>.
tvalentyn commented on issue #22265:
URL: https://github.com/apache/beam/issues/22265#issuecomment-1184418390
.add-labels website
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] Abacn commented on issue #22265: [Task]: Make pydoc docstring reflecting deprecated and experimental API
Posted by GitBox <gi...@apache.org>.
Abacn commented on issue #22265:
URL: https://github.com/apache/beam/issues/22265#issuecomment-1204255760
.add-labels good_first_issue
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org