Skip to content

Conversation

euanh
Copy link
Collaborator

@euanh euanh commented Apr 30, 2025

Motivation

The help text for --username and --password states that these options override .netrc. In fact they are used as defaults if no suitable entry is found in .netrc.

Modifications

Correct the option descriptions in the manual page.

Result

Documentation accurately describes what the options do.

Test Plan

All existing tests continue to pass. No functional change.

@euanh euanh added area/documentation Improvements or additions to documentation semver/patch No public API change. labels Apr 30, 2025
@euanh euanh merged commit 5cf0cbe into apple:main Apr 30, 2025
23 checks passed
@euanh euanh deleted the docs/correct-username-password-help branch April 30, 2025 14:28
euanh added a commit to euanh/swift-container-plugin that referenced this pull request May 1, 2025
Motivation
----------

The help text for `--username` and `--password` states that these
options override `.netrc`. In fact they are used as defaults if no
suitable entry is found in `.netrc`.

Modifications
-------------

Correct the `--help` option descriptions and manual page.
 
Result
------

Help and documentation accurately describe what the options do.

Test Plan
---------

All existing tests continue to pass.   No functional change.
@euanh euanh mentioned this pull request May 1, 2025
euanh added a commit that referenced this pull request May 1, 2025
Motivation
----------

The help text for `--username` and `--password` states that these
options override `.netrc`. In fact they are used as defaults if no
suitable entry is found in `.netrc`.

Modifications
-------------

Correct the `--help` option descriptions and manual page.
 
Result
------

Help and documentation accurately describe what the options do.

Test Plan
---------

All existing tests continue to pass.   No functional change.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Improvements or additions to documentation semver/patch No public API change.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant