Skip to content

Make docs for several filesystem operations clearer.#3409

Open
Lukasa wants to merge 1 commit intoapple:mainfrom
Lukasa:cb-clean-up-docs
Open

Make docs for several filesystem operations clearer.#3409
Lukasa wants to merge 1 commit intoapple:mainfrom
Lukasa:cb-clean-up-docs

Conversation

@Lukasa
Copy link
Copy Markdown
Contributor

@Lukasa Lukasa commented Oct 15, 2025

Motivation:

The relationship between moveItem(at:to:) and
replaceItem(at:withItemAt:) is not terribly clear. It would be good if their behaviours were more obvious.

Modifications:

Clean up the docs.

Result:

Makes the docs clearer. Resolves #3406.

Motivation:

The relationship between moveItem(at:to:) and
replaceItem(at:withItemAt:) is not terribly clear.
It would be good if their behaviours were more obvious.

Modifications:

Clean up the docs.

Result:

Makes the docs clearer. Resolves apple#3406.
@Lukasa Lukasa added the semver/none No version bump required. label Oct 15, 2025
do {
try await self.removeItem(at: destinationPath, strategy: .platformDefault)
try await self.moveItem(at: existingPath, to: destinationPath)
try await self.removeItem(at: existingPath, strategy: .platformDefault)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this intentional? PR description says it's just updating docs..

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

semver/none No version bump required.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

NIOFileSystem: Make it clear in the docs (or possibly rename the API) that replaceItem _moves_ an item

2 participants