More docs for .new deprecation warning #1796
Open
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
![modal-pr-review-automation[bot]](https://avatars.githubusercontent.com/in/335990?s=60&v=4){kind=small}
erikbern
force-pushed
the
erikbern/new-depr-warning-docs
branch
from
f631ce6
to
ca47050
Compare
mwaskom
reviewed
May 6, 2024
| @@ -87,7 +87,9 @@ class _Queue(_Object, type_prefix="qu"): | |||
| def new(): | |||
| """`Queue.new` is deprecated. | |||
|
|
|||
| Please use `Queue.from_name` (for persisted) or `Queue.ephemeral` (for ephemeral) queues. | |||
| You can switch this out for `Queue.from_name("some-queue-identifier")` for persisted dicts. | |||
There was a problem hiding this comment.
Suggested change
| You can switch this out for `Queue.from_name("some-queue-identifier")` for persisted dicts. | |
| You can switch this out for `Queue.from_name("some-queue-identifier")` for persisted queues. |
| @@ -139,7 +139,9 @@ def _initialize_from_empty(self): | |||
| def new() -> "_Volume": | |||
| """`Volume.new` is deprecated. | |||
|
|
|||
| Please use `Volume.from_name` (for persisted) or `Volume.ephemeral` (for ephemeral) volumes. | |||
| You can switch this out for `Volume.from_name("some-volume-identifier")` for persisted dicts. | |||
There was a problem hiding this comment.
Suggested change
| You can switch this out for `Volume.from_name("some-volume-identifier")` for persisted dicts. | |
| You can switch this out for `Volume.from_name("some-volume-identifier")` for persisted volumes. |
aksh-at
reviewed
May 6, 2024
Comment on lines
+143
to
+144
| You can also take a look at the documentation for `Volume.ephemeral` for another option, | ||
| although it might require more code changes if you're coming from `Volume.new`. |
There was a problem hiding this comment.
I had a hard time finding which docs this refers to. Is it https://modal.com/docs/reference/modal.Volume#ephemeral? Ideally we should add a guide page on "ephemeral objects" and link to that here directly
|
Should we close this now that it's an error? |
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.
Slightly more docs to make it clear that
.new->.ephemeralis not a straightforward substitution