📒 docs: Remove deprecated comments and documenting recent changes #3498
Conversation
WalkthroughDeprecated constants and configuration fields related to MIME types, cache, limiter, and logger middleware have been removed from both code and documentation. Documentation updates clarify these removals, provide migration guidance, and highlight the new recommended alternatives for affected features. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
participant Middleware
User->>Documentation: Consults config/constants
Documentation-->>User: Presents updated fields/constants
User->>Middleware: Uses new config fields/constants
Middleware-->>User: Processes request with updated logic
Suggested labels
Suggested reviewers
Poem
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Pull Request Overview
This PR removes deprecated comments and updates documentation to reflect the current naming conventions for constants and middleware options.
- Removed deprecated MIME constants and updated their documentation.
- Removed deprecated middleware options and related comments from logger, limiter, and cache documentation.
- Clarified deprecation notes in the release notes and API documentation.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/whats_new.md | Added notes about deprecated MIME constants and middleware options with recommendations. |
| docs/middleware/logger.md | Removed the deprecated TagHeader comment to align with current naming conventions. |
| docs/middleware/limiter.md | Removed deprecated fields and updated the note to only show supported options. |
| docs/middleware/cache.md | Removed deprecated field comments to reflect the current API design. |
| docs/api/constants.md | Removed deprecated MIME constant definitions and referenced their replacements. |
| constants.go | Removed deprecated MIME constants and associated comments to enforce current best practices. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3498 +/- ##
=======================================
Coverage 83.89% 83.89%
=======================================
Files 120 120
Lines 12272 12272
=======================================
Hits 10296 10296
Misses 1553 1553
Partials 423 423
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/whats_new.md (1)
177-180: Link to API constants reference.The
### MIME Constantssection introduces the deprecation note for JavaScript MIME types but doesn’t reference the source of truth. Consider adding a link to the updateddocs/api/constants.mdso users can see the full current list:### MIME Constants +See [API constants reference](docs/api/constants.md) for all supported MIME types. `MIMEApplicationJavaScript` and `MIMEApplicationJavaScriptCharsetUTF8` are deprecated. Use `MIMETextJavaScript` and `MIMETextJavaScriptCharsetUTF8` instead.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
constants.go(1 hunks)docs/api/constants.md(0 hunks)docs/middleware/cache.md(0 hunks)docs/middleware/limiter.md(0 hunks)docs/middleware/logger.md(0 hunks)docs/whats_new.md(4 hunks)
💤 Files with no reviewable changes (4)
- docs/middleware/cache.md
- docs/middleware/limiter.md
- docs/middleware/logger.md
- docs/api/constants.md
⏰ Context from checks skipped due to timeout of 90000ms (5)
- GitHub Check: unit (1.24.x, macos-13)
- GitHub Check: unit (1.24.x, windows-latest)
- GitHub Check: unit (1.24.x, macos-latest)
- GitHub Check: repeated
- GitHub Check: Compare
🔇 Additional comments (4)
constants.go (1)
27-29: Missing documentation for new MIME constants.The newly added constants
MIMEApplicationForm,MIMEOctetStream, andMIMEMultipartFormaren’t mentioned in the AI summary or the API docs (docs/api/constants.md). Please update the documentation to cover these additions for consistency.Likely an incorrect or invalid review comment.
docs/whats_new.md (3)
986-989: Clear deprecation note for cache middleware.This
:::notesuccinctly explains the removal of the deprecatedStoreandKeyoptions and points to the newStorageandKeyGeneratorfields. It aligns well with the migration guidance.
1086-1089: Good deprecation note for logger middleware.This
:::noteclearly informs users about the removal of theTagHeaderconstant and the alternativeTagReqHeader. It’s a helpful addition for migration.
1208-1210: Helpful deprecation note for limiter middleware.The
:::notecleanly communicates thatDuration,Store, andKeyhave been removed and directs users toExpiration,Storage, andKeyGeneratorinstead. Nice clarity.
gaby
changed the title
No description provided.