📒 docs: improve deprecated comments by alexandear · Pull Request #187 · gofiber/utils

alexandear · 2026-03-13T12:08:17Z

This PR improves deprecated functions:

Now godoc links are clickable.
Now we can use go fix -inline to automatically migrate, see https://go.dev/blog/inliner.

Before:

After:

Summary by CodeRabbit

Refactor
- Updated deprecation notices for ToLowerBytes, ToUpperBytes, ToLower, and ToUpper functions with direct references to their replacements in the new utility package location. Users should migrate to the updated function paths for continued support.

gemini-code-assist · 2026-03-13T12:08:33Z

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the developer experience when dealing with deprecated utility functions. It updates the deprecation notices to provide clickable links to the recommended replacement functions in godoc, making it easier for users to navigate to the correct alternatives. Additionally, it introduces go:fix inline directives, enabling automated code migration for these deprecated functions, streamlining the update process for users.

Highlights

Improved Deprecation Comments: Deprecation comments for ToLowerBytes, ToUpperBytes, ToLower, and ToUpper functions were updated to use the new Go documentation link format, making them clickable in godoc.
Enabled go fix -inline Migration: The go:fix inline directive was added to the deprecated functions, allowing users to automatically migrate their code using go fix -inline.

Changelog

bytes.go
- Updated ToLowerBytes deprecation comment to use [github.com/gofiber/utils/v2/bytes.UnsafeToLower] and added //go:fix inline.
- Updated ToUpperBytes deprecation comment to use [github.com/gofiber/utils/v2/bytes.UnsafeToUpper] and added //go:fix inline.
strings.go
- Updated ToLower deprecation comment to use [github.com/gofiber/utils/v2/strings.ToLower] and added //go:fix inline.
- Updated ToUpper deprecation comment to use [github.com/gofiber/utils/v2/strings.ToUpper] and added //go:fix inline.

Activity

No human activity has been recorded on this pull request yet.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request updates the deprecation notices for several functions in bytes.go and strings.go. The changes include updating the Deprecated comments to a format that generates clickable links in godoc, and adding the //go:fix inline directive to enable automatic code migration via go fix. The implementation aligns with the recommendations for using these Go features. No issues were found in the changes.

coderabbitai · 2026-03-13T12:11:26Z

📝 Walkthrough

Walkthrough

Updates deprecation comments and adds //go:fix inline directives to utility functions in bytes and strings modules, guiding developers toward newer unsafe variants without altering any functionality.

Changes

Cohort / File(s)	Summary
Deprecation and Go Fix Updates `bytes.go`, `strings.go`	Updated deprecation comments to reference bracketed function paths (UnsafeToLower/UnsafeToUpper) and added `//go:fix` inline directives to facilitate automated migration of callers.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~5 minutes

Possibly related PRs

semantics: explicit mutating APIs, safe replacements #186: Refactors and delegates ToLower/ToUpper and ToLowerBytes/ToUpperBytes functions to new unsafe/non-mutating variants that this PR now references in deprecation notices.
Improve utils performance #116: Modifies the implementations of the same ToLower/ToUpper functions being deprecated in this PR for performance improvements.
refactor: update utils and add go 1.26 for test workflow fiber#4087: Introduces and renames UnsafeToLower/UnsafeToUpper functions that are the target replacements referenced in the updated deprecation comments.

Suggested labels

🧹 Updates

Suggested reviewers

ReneWerner87
sixcolors
gaby

Poem

🐰 The bytes and strings hop along with care,
Their deprecation notes now guide you there!
Go:fix directives point the weary way,
To unsafe variants, bright and gay! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Title check	✅ Passed	The title 'docs: improve deprecated comments' accurately describes the main change in the PR, which updates deprecation comments and adds go:fix directives to enable automatic migration.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

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.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

docs: improve deprecated comments; use go:fix inline

a6f83d2

alexandear requested a review from a team as a code owner March 13, 2026 12:08

alexandear requested review from ReneWerner87, efectn, gaby and sixcolors and removed request for a team March 13, 2026 12:08

ReneWerner87 added the 📒 Documentation Improvements or additions to documentation label Mar 13, 2026

gemini-code-assist Bot reviewed Mar 13, 2026

View reviewed changes

gaby approved these changes May 25, 2026

View reviewed changes

gaby changed the title ~~docs: improve deprecated comments; use go:fix inline~~ 📒 docs: improve deprecated comments May 25, 2026

ReneWerner87 approved these changes May 25, 2026

View reviewed changes

ReneWerner87 merged commit 17647e0 into gofiber:master May 25, 2026
5 checks passed

alexandear deleted the docs/improve-deprecated branch May 25, 2026 19:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

📒 docs: improve deprecated comments#187

📒 docs: improve deprecated comments#187
ReneWerner87 merged 1 commit into
gofiber:masterfrom
alexandear-org:docs/improve-deprecated

alexandear commented Mar 13, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

gemini-code-assist Bot commented Mar 13, 2026

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

coderabbitai Bot commented Mar 13, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Uh oh!

Conversation

alexandear commented Mar 13, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

gemini-code-assist Bot commented Mar 13, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

coderabbitai Bot commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

alexandear commented Mar 13, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Mar 13, 2026 •

edited

Loading