apple/swift-nio

Remove underbar prefix from _NIOFileSystem

Open

#3,052 opened on Jan 13, 2025

View on GitHub
 (9 comments) (0 reactions) (0 assignees)Swift (8,453 stars) (749 forks)batch import
good first issue

Description

I assume _NIOFileSystem is considered to be a public API now, given NonBlockingFileIO has been deprecated in its favour. Is it not time to remove the underbar prefix from its name. This is the quote from its original release

The module isn't yet considered public API and is therefore available via the _NIOFileSystem product.

Contributor guide

Tech stack
swift
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Swift knowledgeFamiliarity with SwiftNIO module structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Identify all occurrences of ` NIOFileSystem` in the codebase, including imports and references. Verify that the module is intended to be public API and update documentation. Consider deprecating the old name or providing a typealias for backward compatibility. Check the issue comments for any maintainer guidance.