Make utils.functional.retry_over_time appear in rendered docs
#1245
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Since this module has `__all__`, autodoc will (by default) only show docs for those members, meaning retry_over_time is not shown in the rendered docs. This function is used by the Redis result backend in Celery, and it has a doc comment so it should be "public".
|
This was discovered cos I wanted to link to it from the new docs in celery/celery#6330 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since this module has
__all__, autodoc will (by default) only show docs for thosemembers, meaning retry_over_time is not shown in the rendered docs.
This function is used by the Redis result backend in Celery, and it has a doc
comment so it should be "public".