Skip to content

Clarify optional None parameters in docstrings #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

IceboxDev
Copy link

📝 Description

Docstrings across the cache modules were overly strict about parameter types, omitting that several values—such as expire, tag, or directory 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

  • 🐞 Bug fix (non-breaking change which fixes an issue)
  • 🔨 Refactor (non-breaking change which refactors the code base)
  • 🚀 New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📚 Documentation update
  • 🔒 Security update

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant