PowerShell / PowerShell/PowerShellEditorServices

Get rid of optional parameters in API function signatures

Open
#23 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue-Enhancement
Dominant language
C#
Stars
767
Forks
266
Avg merge
3d 16h
Merged PRs (30d)
1

Description

Apparently optional parameters cause issues with backwards compatibility in .NET APIs. Best to remove that pattern entirely.

More info: http://haacked.com/archive/2010/08/10/versioning-issues-with-optional-arguments.aspx/

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, entry points, or tests. Start by locating public .NET API signatures that use optional parameters and review the linked compatibility guidance; confirm the affected scope and validation steps with maintainers. Done means the targeted API signatures no longer use optional parameters without breaking supported compatibility.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
api
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.