Clarify optional None parameters in docstrings #351
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.
📝 Description
Docstrings across the cache modules were overly strict about parameter types, omitting that several values—such as
expire
,tag
, ordirectory
could legitimately be None. This led to confusing type-hint warnings. The updated docstrings explicitly document optional None values throughout the core, fanout, Django cache, persistent cache, and recipe helpers, ensuring the documentation matches actual behavior.✨ Changes