mbstring: Do functions marked “TODO Return void” require an RFC to change return type?
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 40.4k
- Forks
- 8.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 96
Description
Hi,
In ext/mbstring/php_mbregex.c, I noticed several places with comments like:
// TODO Return void
RETURN_TRUE;
ext/mbstring/php_mbregex.c:1567
This suggests the intent is to change these functions to return void instead of bool.
Before preparing a patch, I wanted to confirm the process:
Would changing these functions from returning true to void (i.e., RETURN_NULL() in C and updating stubs to: void) require an RFC?
Or is this considered a minor/internal API cleanup that can go directly as a PR?
I’m aware that this could have a userland impact if the return value is currently used, so I wanted to check what the preferred approach is.
Happy to prepare a PR once the direction is clarified.
Thanks!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at ext/mbstring/php_mbregex.c:1567 and review the surrounding TODO comments and the related function stubs mentioned in the issue. Determine whether changing the return type affects the userland API and requires an RFC; the issue is done when the project process and scope are confirmed before preparing a patch.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, php
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100