Skip to content

Conversation

@kalel-commits
Copy link

@kalel-commits kalel-commits commented Feb 1, 2026

This PR clarifies existing TODOs by documenting known limitations in the
is_hidden() docstring. No behavior is changed.

@kalel-commits kalel-commits requested a review from a team as a code owner February 1, 2026 12:43
Copilot AI review requested due to automatic review settings February 1, 2026 12:43
@github-actions
Copy link

github-actions bot commented Feb 1, 2026

Thank you for the PR! The changelog has not been updated, so here is a friendly reminder to check if you need to add an entry.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR enhances the docstring of the is_hidden function by documenting current implementation details that correspond to existing TODOs in the code.

Changes:

  • Added a note to the is_hidden function docstring explaining that platform-specific checks are performed on each invocation and that bytes inputs are supported for backward compatibility

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Determine whether the given path is treated as a 'hidden file' by the OS.

Note: A platform-specific check is performed on each invocation. Bytes
inputs are supported for backward compatibility.
Copy link
Member

@JOJ0 JOJ0 Feb 1, 2026

Choose a reason for hiding this comment

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

I might be slow here but what did you intend to clarify? Lines 25-27 tell exactly the same already. Maybe I'm missing something, please elaborate your idea here.

Copy link
Author

@kalel-commits kalel-commits Feb 1, 2026

Choose a reason for hiding this comment

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

Thanks for the look happy to elaborate the intention here was not to provide any new information, rather to declare the meaning of TODOs that already exists in the docstring.

currently the docstring is an explanation of what the function does, but the TODOs are clues to a couple details that might not be obvious behind this operation:
that a platform-dependent check is performed on each call, and since bytes inputs still have support largely for backwards compatibility.

This note seemed like an attempt to bring that detail out for readers without having them know to go find or understand the TODO comments.

If this does feel a bit redundant or not useful I will drop the changes.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants