fix deprecation comment for (FlagSet.)ParseErrorsWhitelist #447
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
thaJeztah
commented
Sep 1, 2025
| // This type will be removed in a future release | ||
| // ParseErrorsWhitelist defines the parsing errors that can be ignored. | ||
| // | ||
| // Deprecated: use [ParseErrorsAllowlist] instead. This type will be removed in a future release. |
Author
There was a problem hiding this comment.
FWIW, to follow SemVer; this type can't be removed until a v2 release
Author
|
cc @tomasaschan PTAL |
tomasaschan
approved these changes
Sep 1, 2025
Collaborator
tomasaschan
left a comment
tomasaschan
left a comment
There was a problem hiding this comment.
Thank you so much for helping out with this.
I have one question about what looks like spurious whitespace changes, but other than that I think we should just merge this and tag 1.0.10 to make it show up properly on pkg.go.dev.
flag.go
Outdated
Comment on lines
963
to
973
| // --unknown | ||
| return args | ||
| } | ||
|
|
||
| first := args[0] | ||
| if len(first) > 0 && first[0] == '-' { | ||
| //--unknown --next-flag ... | ||
| // --unknown --next-flag ... | ||
| return args | ||
| } | ||
|
|
||
| //--unknown arg ... (args will be arg ...) | ||
| // --unknown arg ... (args will be arg ...) |
Collaborator
There was a problem hiding this comment.
Are these whitespace changes go fmt or something else?
(I don't mind the changes, I just want to make sure they won't cause a similar but reverted diff the next time someone touches this file.)
Author
There was a problem hiding this comment.
oh! Yes, that'd be my IDE fixing format; Go comments must have a leading whitespace, except for "programatically parseable" comments (usually //nolint:<something> , which must be formatted golang/go#37974 (comment)
//<some alphanumeric identifier>:<options>[,<option>...][ // comment]
Let me remove those here as they're not related to this change.
Commit 7412009 added back these types and marked them as deprecated, but did not use the correct format as documented in the [go documentation]. Deprecation comments should be in their own paragraph within the GoDoc, and start with `Deprecated:`, which is case-sensitive. Currently, the deprecation comment is not properly detected, and does not show up as deprecated on [pkg.go.dev]. This patch; - Fixes the deprecation comments to be in the right format. - Updates the GoDoc to use a "docs link" to refer to their replacement, which creates a link to those types on pkg.go.dev. - Adds back GoDoc for the deprecated functions to make sure the GoDoc is in the correct format and keep linters happy. [go documentation]: https://go.dev/doc/comment#deprecations [pkg.go.dev]: https://pkg.go.dev/github.com/spf13/pflag@v1.0.9#ParseErrorsWhitelist Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
thaJeztah
force-pushed
the
fix_deprecation_comment
branch
from
4b2fb5d to
45a4873
Compare
Author
|
Reverted the unrelated changes; this should be good for review again 👍 |
tomasaschan
approved these changes
Sep 2, 2025
project-mirrors-bot-tu bot
pushed a commit
to project-mirrors/forgejo-runner
that referenced
this pull request
Oct 11, 2025
This PR contains the following updates: | Package | Change | Age | Confidence | |---|---|---|---| | [github.com/spf13/pflag](https://github.com/spf13/pflag) | `v1.0.9` -> `v1.0.10` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>spf13/pflag (github.com/spf13/pflag)</summary> ### [`v1.0.10`](https://github.com/spf13/pflag/releases/tag/v1.0.10) [Compare Source](spf13/pflag@v1.0.9...v1.0.10) #### What's Changed - fix deprecation comment for (FlagSet.)ParseErrorsWhitelist by [@​thaJeztah](https://github.com/thaJeztah) in [#​447](spf13/pflag#447) - remove uses of errors.Is, which requires go1.13, move go1.16/go1.21 tests to separate file by [@​thaJeztah](https://github.com/thaJeztah) in [#​448](spf13/pflag#448) #### New Contributors - [@​thaJeztah](https://github.com/thaJeztah) made their first contribution in [#​447](spf13/pflag#447) **Full Changelog**: <spf13/pflag@v1.0.9...v1.0.10> </details> --- ### Configuration 📅 **Schedule**: Branch creation - Between 12:00 AM and 03:59 AM ( * 0-3 * * * ) (UTC), Automerge - Between 12:00 AM and 03:59 AM ( * 0-3 * * * ) (UTC). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MS45MS4yIiwidXBkYXRlZEluVmVyIjoiNDEuOTEuMiIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiS2luZC9DaG9yZSIsInJ1bi1lbmQtdG8tZW5kLXRlc3RzIl19--> <!--start release-notes-assistant--> <!--URL:https://code.forgejo.org/forgejo/runner--> - other - [PR](https://code.forgejo.org/forgejo/runner/pulls/932): <!--number 932 --><!--line 0 --><!--description VXBkYXRlIG1vZHVsZSBnaXRodWIuY29tL3NwZjEzL3BmbGFnIHRvIHYxLjAuMTA=-->Update module github.com/spf13/pflag to v1.0.10<!--description--> <!--end release-notes-assistant--> Reviewed-on: https://code.forgejo.org/forgejo/runner/pulls/932 Reviewed-by: earl-warren <earl-warren@noreply.code.forgejo.org> Co-authored-by: Renovate Bot <bot@kriese.eu> Co-committed-by: Renovate Bot <bot@kriese.eu>
algitbot
pushed a commit
to alpinelinux/build-server-status
that referenced
this pull request
Nov 9, 2025
This MR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/spf13/pflag](https://github.com/spf13/pflag) | require | patch | `v1.0.6` -> `v1.0.10` | --- ### Release Notes <details> <summary>spf13/pflag (github.com/spf13/pflag)</summary> ### [`v1.0.10`](https://github.com/spf13/pflag/releases/tag/v1.0.10) [Compare Source](spf13/pflag@v1.0.9...v1.0.10) #### What's Changed - fix deprecation comment for (FlagSet.)ParseErrorsWhitelist by [@​thaJeztah](https://github.com/thaJeztah) in [#​447](spf13/pflag#447) - remove uses of errors.Is, which requires go1.13, move go1.16/go1.21 tests to separate file by [@​thaJeztah](https://github.com/thaJeztah) in [#​448](spf13/pflag#448) #### New Contributors - [@​thaJeztah](https://github.com/thaJeztah) made their first contribution in [#​447](spf13/pflag#447) **Full Changelog**: <spf13/pflag@v1.0.9...v1.0.10> ### [`v1.0.9`](https://github.com/spf13/pflag/releases/tag/v1.0.9) [Compare Source](spf13/pflag@v1.0.8...v1.0.9) #### What's Changed - fix: Restore ParseErrorsWhitelist name for now by [@​tomasaschan](https://github.com/tomasaschan) in [#​446](spf13/pflag#446) **Full Changelog**: <spf13/pflag@v1.0.8...v1.0.9> ### [`v1.0.8`](https://github.com/spf13/pflag/releases/tag/v1.0.8) [Compare Source](spf13/pflag@v1.0.7...v1.0.8) ####⚠️ Breaking Change This version, while only a patch bump, includes a (very minor) breaking change: the `flag.ParseErrorsWhitelist` struct and corresponding `FlagSet.parseErrorsWhitelist` field have been renamed to `ParseErrorsAllowlist`. This should result in compilation errors in any code that uses these fields, which can be fixed by adjusting the names at call sites. There is no change in semantics or behavior of the struct or field referred to by these names. If your code compiles without errors after bumping to/past v1.0.8, you are not affected by this change. The breaking change was reverted in v1.0.9, by means of re-introducing the old names with deprecation warnings. The plan is still to remove them in a future release, so if your code does depend on the old names, please change them to use the new names at your earliest convenience. #### What's Changed - Remove Redundant "Unknown-Flag" Error by [@​vaguecoder](https://github.com/vaguecoder) in [#​364](spf13/pflag#364) - Switching from whitelist to Allowlist terminology by [@​dubrie](https://github.com/dubrie) in [#​261](spf13/pflag#261) - Omit zero time.Time default from usage line by [@​mologie](https://github.com/mologie) in [#​438](spf13/pflag#438) - implement CopyToGoFlagSet by [@​pohly](https://github.com/pohly) in [#​330](spf13/pflag#330) - flag: Emulate stdlib behavior and do not print ErrHelp by [@​tmc](https://github.com/tmc) in [#​407](spf13/pflag#407) - Print Default Values of String-to-String in Sorted Order by [@​vaguecoder](https://github.com/vaguecoder) in [#​365](spf13/pflag#365) - fix: Don't print ErrHelp in ParseAll by [@​tomasaschan](https://github.com/tomasaschan) in [#​443](spf13/pflag#443) - Reset args on re-parse even if empty by [@​tomasaschan](https://github.com/tomasaschan) in [#​444](spf13/pflag#444) #### New Contributors - [@​vaguecoder](https://github.com/vaguecoder) made their first contribution in [#​364](spf13/pflag#364) - [@​dubrie](https://github.com/dubrie) made their first contribution in [#​261](spf13/pflag#261) - [@​mologie](https://github.com/mologie) made their first contribution in [#​438](spf13/pflag#438) - [@​pohly](https://github.com/pohly) made their first contribution in [#​330](spf13/pflag#330) - [@​tmc](https://github.com/tmc) made their first contribution in [#​407](spf13/pflag#407) - [@​tomasaschan](https://github.com/tomasaschan) made their first contribution in [#​443](spf13/pflag#443) **Full Changelog**: <spf13/pflag@v1.0.7...v1.0.8> ### [`v1.0.7`](https://github.com/spf13/pflag/releases/tag/v1.0.7) [Compare Source](spf13/pflag@v1.0.6...v1.0.7) #### What's Changed - Fix defaultIsZeroValue check for generic Value types by [@​MidnightRocket](https://github.com/MidnightRocket) in [#​422](spf13/pflag#422) - feat: Use structs for errors returned by pflag. by [@​eth-p](https://github.com/eth-p) in [#​425](spf13/pflag#425) - Fix typos by [@​co63oc](https://github.com/co63oc) in [#​428](spf13/pflag#428) - fix [#​423](spf13/pflag#423) : Add helper function and some documentation to parse shorthand go test flags. by [@​valdar](https://github.com/valdar) in [#​424](spf13/pflag#424) - add support equivalent to golang flag.TextVar(), also fixes the test failure as described in [#​368](spf13/pflag#368) by [@​hujun-open](https://github.com/hujun-open) in [#​418](spf13/pflag#418) - add support for Func() and BoolFunc() [#​426](spf13/pflag#426) by [@​LeGEC](https://github.com/LeGEC) in [#​429](spf13/pflag#429) - fix: correct argument length check in FlagSet.Parse by [@​ShawnJeffersonWang](https://github.com/ShawnJeffersonWang) in [#​409](spf13/pflag#409) - fix usage message for func flags, fix arguments order by [@​LeGEC](https://github.com/LeGEC) in [#​431](spf13/pflag#431) - Add support for time.Time flags by [@​max-frank](https://github.com/max-frank) in [#​348](spf13/pflag#348) #### New Contributors - [@​MidnightRocket](https://github.com/MidnightRocket) made their first contribution in [#​422](spf13/pflag#422) - [@​eth-p](https://github.com/eth-p) made their first contribution in [#​425](spf13/pflag#425) - [@​co63oc](https://github.com/co63oc) made their first contribution in [#​428](spf13/pflag#428) - [@​valdar](https://github.com/valdar) made their first contribution in [#​424](spf13/pflag#424) - [@​hujun-open](https://github.com/hujun-open) made their first contribution in [#​418](spf13/pflag#418) - [@​LeGEC](https://github.com/LeGEC) made their first contribution in [#​429](spf13/pflag#429) - [@​ShawnJeffersonWang](https://github.com/ShawnJeffersonWang) made their first contribution in [#​409](spf13/pflag#409) - [@​max-frank](https://github.com/max-frank) made their first contribution in [#​348](spf13/pflag#348) **Full Changelog**: <spf13/pflag@v1.0.6...v1.0.7> </details> --- - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box --- <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MC4zNy4xIiwidXBkYXRlZEluVmVyIjoiNDEuMTczLjEiLCJ0YXJnZXRCcmFuY2giOiJtYXN0ZXIiLCJsYWJlbHMiOltdfQ==--> See merge request alpine/infra/build-server-status!21
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Commit 7412009 added back these types and marked them as deprecated, but did not use the correct format as documented in the go documentation.
Deprecation comments should be in their own paragraph within the GoDoc, and start with
Deprecated:, which is case-sensitive. Currently, the deprecation comment is not properly detected, and does not show up as deprecated on pkg.go.dev.This patch;
Before this patch:
With this patch: